Doxygen: Add initial main page

1 files changed, 33 insertions, 0 deletions

diff --git a/libswo/core.c b/libswo/core.c
index 75dd85c..34ff972 100644
--- a/libswo/core.c
+++ b/libswo/core.c
@@ -24,6 +24,39 @@
 #include "libswo-internal.h"
 
 /**
+ * @mainpage
+ *
+ * @section sec_intro Introduction
+ *
+ * This document describes the API of libswo.
+ *
+ * libswo is a shared library written in C to decode SWO trace data.
+ *
+ * @section sec_error Error handling
+ *
+ * The libswo functions which can fail use the return value to indicate an
+ * error. The functions typically return an error code of #libswo_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 libswo.
+ *
+ * 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 Copyright and license
+ *
+ * libswo is licensed under the terms of the GNU General Public License (GPL),
+ * version 3 or later.
+ *
+ * @section sec_website Website
+ *
+ * <a href="http://git.zapb.de/libswo.git">git.zapb.de/libswo.git</a>
+ */
+
+/**
  * @file
  *
  * Core library functions.