diff options
author | Marc Schink <swo-dev@marcschink.de> | 2017-10-03 14:01:23 +0200 |
---|---|---|
committer | Marc Schink <swo-dev@marcschink.de> | 2017-10-03 14:19:13 +0200 |
commit | e4ed47910e381f64cf39010f9faa02a609ec7887 (patch) | |
tree | 4ec2b0a655d951e9ec0112cbce5bffdac5f7877b | |
parent | 0af40869fddd7b7f94216c3534e7a1b055fad99f (diff) |
Doxygen: Add initial main page
-rw-r--r-- | libswo/core.c | 33 |
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. |