From: Uwe Hermann Date: Sat, 9 Feb 2013 21:25:15 +0000 (+0100) Subject: Doxygen: Initial groups and topic short descriptions. X-Git-Tag: libsigrokdecode-0.2.0~20 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=4895418c6800ecb128ed36af2a1bc46916c9be85;p=libsigrokdecode.git Doxygen: Initial groups and topic short descriptions. --- diff --git a/controller.c b/controller.c index 44fd6c7..e35b8be 100644 --- a/controller.c +++ b/controller.c @@ -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. * diff --git a/decoder.c b/decoder.c index 34e3d95..3d20b26 100644 --- a/decoder.c +++ b/decoder.c @@ -29,6 +29,14 @@ * 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 e68014c..95e3535 100644 --- a/log.c +++ b/log.c @@ -29,6 +29,14 @@ * 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; } + +/** @} */ diff --git a/version.c b/version.c index 55ad776..1f9c98e 100644 --- a/version.c +++ b/version.c @@ -26,6 +26,14 @@ * 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; } + +/** @} */