diff options
author | Marc Schink <jaylink-dev@marcschink.de> | 2016-10-30 21:49:22 +0100 |
---|---|---|
committer | Marc Schink <jaylink-dev@marcschink.de> | 2016-11-05 14:40:00 +0100 |
commit | 0f42a333f909d6262f7bf48b12db85daf5c93ca0 (patch) | |
tree | 64ee40aeaa51e0510aa901991d229392fcd070e0 | |
parent | 1dab6eddfbbd00a8cafa87f4b52e2e35afd3272b (diff) | |
download | libjaylink-0f42a333f909d6262f7bf48b12db85daf5c93ca0.zip libjaylink-0f42a333f909d6262f7bf48b12db85daf5c93ca0.tar.gz libjaylink-0f42a333f909d6262f7bf48b12db85daf5c93ca0.tar.bz2 |
Doxygen: Add initial main page
Signed-off-by: Marc Schink <jaylink-dev@marcschink.de>
-rw-r--r-- | libjaylink/core.c | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/libjaylink/core.c b/libjaylink/core.c index 67b66f4..6bf4cc4 100644 --- a/libjaylink/core.c +++ b/libjaylink/core.c @@ -27,6 +27,36 @@ #include "libjaylink-internal.h" /** + * @mainpage + * + * @section sec_intro Introduction + * + * This document describes the API of libjaylink. + * + * libjaylink is a shared library written in C to access SEGGER J-Link and + * compatible devices. + * + * @section sec_error Error handling + * + * The libjaylink functions which can fail use the return value to indicate an + * error. The functions typically return an error code of #jaylink_error. + * For each function, all possible error codes and their detailed descriptions + * are documented. As the possible error codes returned by a function may + * change it is recommended to also always cover unexpected values when + * checking for error codes to be compatible with later versions of libjaylink. + * + * There are a few exceptions where a function directly returns the result + * instead of an error code because it is more convenient from an API + * perspective and because there is only a single reason for failure which is + * clearly distinguishable from the result. + * + * @section sec_license License + * + * libjaylink is licensed under the terms of the GNU General Public + * License (GPL), version 2 or later. + */ + +/** * @file * * Core library functions. |