diff options
-rw-r--r-- | decoder.c | 6 | ||||
-rw-r--r-- | log.c | 6 | ||||
-rw-r--r-- | sigrokdecode.h.in | 16 | ||||
-rw-r--r-- | version.c | 6 |
4 files changed, 34 insertions, 0 deletions
@@ -23,6 +23,12 @@ #include "sigrokdecode-internal.h" #include <glib.h> +/** + * @file + * + * Listing, loading, unloading, and handling protocol decoders. + */ + /** @cond PRIVATE */ /* The list of protocol decoders. */ @@ -23,6 +23,12 @@ #include <stdarg.h> #include <stdio.h> +/** + * @file + * + * Controlling the libsigrokdecode message logging functionality. + */ + /* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */ static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */ diff --git a/sigrokdecode.h.in b/sigrokdecode.h.in index 033e30e..ca069c5 100644 --- a/sigrokdecode.h.in +++ b/sigrokdecode.h.in @@ -30,6 +30,22 @@ extern "C" { #endif +/** + * @file + * + * The public libsigrokdecode header file to be used by frontends. + * + * This is the only file that libsigrokdecode users (frontends) are supposed + * to use and include. There are other header files which get installed with + * libsigrokdecode, but those are not meant to be used directly by frontends. + * + * The correct way to get/use the libsigrokdecode API functions is: + * + * @code{.c} + * #include <sigrokdecode.h> + * @endcode + */ + /* * Package version macros (can be used for conditional compilation). */ @@ -20,6 +20,12 @@ #include "sigrokdecode.h" +/** + * @file + * + * Version number querying functions. + */ + SRD_API int srd_package_version_major_get(void) { return SRD_PACKAGE_VERSION_MAJOR; |