Doxygen: Initial groups and topic short descriptions.
authorUwe Hermann <uwe@hermann-uwe.de>
Sat, 9 Feb 2013 21:25:15 +0000 (22:25 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Sat, 9 Feb 2013 21:25:15 +0000 (22:25 +0100)
controller.c
decoder.c
log.c
version.c

index 44fd6c76e079359e5a9af4a810bc249a4130385c..e35b8be2a987facf8c7d4bcc45c3cd5bfd4568a3 100644 (file)
@@ -265,6 +265,16 @@ SRD_PRIV int srd_decoder_searchpath_add(const char *path)
        return SRD_OK;
 }
 
+/** @} */
+
+/**
+ * @defgroup grp_instances Decoder instances
+ *
+ * Decoder instance handling.
+ *
+ * @{
+ */
+
 /**
  * Set one or more options in a decoder instance.
  *
@@ -792,6 +802,16 @@ SRD_PRIV void srd_inst_free_all(GSList *stack)
        }
 }
 
+/** @} */
+
+/**
+ * @defgroup grp_session Session handling
+ *
+ * Starting and handling decoding sessions.
+ *
+ * @{
+ */
+
 /**
  * Start a decoding session.
  *
index 34e3d957d5fb034c0033927ae34956ed42e78299..3d20b26b115770daca4eb1a14172c19662a4f377 100644 (file)
--- a/decoder.c
+++ b/decoder.c
  * Listing, loading, unloading, and handling protocol decoders.
  */
 
+/**
+ * @defgroup grp_decoder Protocol decoders
+ *
+ * Handling protocol decoders.
+ *
+ * @{
+ */
+
 /** @cond PRIVATE */
 
 /* The list of protocol decoders. */
@@ -432,3 +440,5 @@ SRD_API int srd_decoder_unload_all(void)
 
        return SRD_OK;
 }
+
+/** @} */
diff --git a/log.c b/log.c
index e68014cd52d52a49c4db8afa0b00b170679e50e8..95e3535723c0319f699b50558629ddc48fba0023 100644 (file)
--- a/log.c
+++ b/log.c
  * Controlling the libsigrokdecode message logging functionality.
  */
 
+/**
+ * @defgroup grp_logging Logging
+ *
+ * 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. */
 
@@ -283,3 +291,5 @@ SRD_PRIV int srd_err(const char *format, ...)
 
        return ret;
 }
+
+/** @} */
index 55ad7764b9e65c55cdf0967859f21c16e23bb6cb..1f9c98e3d3cea052c1bf9a89906980599cbf8e18 100644 (file)
--- a/version.c
+++ b/version.c
  * Version number querying functions.
  */
 
+/**
+ * @defgroup grp_versions Versions
+ *
+ * Version number querying functions.
+ *
+ * @{
+ */
+
 SRD_API int srd_package_version_major_get(void)
 {
        return SRD_PACKAGE_VERSION_MAJOR;
@@ -65,3 +73,5 @@ SRD_API const char *srd_lib_version_string_get(void)
 {
        return SRD_LIB_VERSION_STRING;
 }
+
+/** @} */