|author||Marc Schink <firstname.lastname@example.org>||2016-10-30 21:49:22 +0100|
|committer||Marc Schink <email@example.com>||2016-11-05 14:40:00 +0100|
Doxygen: Add initial main page
Signed-off-by: Marc Schink <firstname.lastname@example.org>
1 files changed, 30 insertions, 0 deletions
diff --git a/libjaylink/core.c b/libjaylink/core.c
index 67b66f4..6bf4cc4 100644
@@ -27,6 +27,36 @@
+ * @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.
* Core library functions.