Doxygen: Add @file items for the relevant files.
authorUwe Hermann <uwe@hermann-uwe.de>
Sat, 9 Feb 2013 21:10:57 +0000 (22:10 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Sat, 9 Feb 2013 21:15:54 +0000 (22:15 +0100)
These short descriptions are shown in the "Files" section of the
Doxygen output.

decoder.c
log.c
sigrokdecode.h.in
version.c

index 52c913aeea0ad6bec6e9f876c4ee93714a112818..34e3d957d5fb034c0033927ae34956ed42e78299 100644 (file)
--- a/decoder.c
+++ b/decoder.c
 #include "sigrokdecode-internal.h"
 #include <glib.h>
 
+/**
+ * @file
+ *
+ * Listing, loading, unloading, and handling protocol decoders.
+ */
+
 /** @cond PRIVATE */
 
 /* The list of protocol decoders. */
diff --git a/log.c b/log.c
index d6df1564126a17c049b3bed2672998a632b8a05e..e68014cd52d52a49c4db8afa0b00b170679e50e8 100644 (file)
--- a/log.c
+++ b/log.c
 #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. */
 
index 033e30ee4652e557097c2facd5f62998eebde4db..ca069c528a3403ac478354267e8ea6ae1cb32f74 100644 (file)
 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).
  */
index 9116574564c94b45077219b6d7220936fac5bbea..55ad7764b9e65c55cdf0967859f21c16e23bb6cb 100644 (file)
--- a/version.c
+++ b/version.c
 
 #include "sigrokdecode.h"
 
+/**
+ * @file
+ *
+ * Version number querying functions.
+ */
+
 SRD_API int srd_package_version_major_get(void)
 {
        return SRD_PACKAGE_VERSION_MAJOR;