doc: add brief explanations for all groups

2025-11-01 22:58:50 -04:00 · 2021-10-04 00:00:41 +03:00 · 2021-10-04 00:00:41 +03:00 · 49901f2d61
commit 49901f2d61
parent 125051a700
44 changed files with 46 additions and 31 deletions
--- a/spa/include/spa/control/control.h
+++ b/spa/include/spa/control/control.h
@ -33,7 +33,7 @@ extern "C" {
 #include <spa/pod/pod.h>

 /** \defgroup spa_control Control
- *
+ * Control type declarations
 */

 /**
--- a/spa/include/spa/debug/buffer.h
+++ b/spa/include/spa/debug/buffer.h
@ -30,7 +30,7 @@ extern "C" {
 #endif

 /** \defgroup spa_debug Debug
- *
+ * Debugging utilities
 */

 /**
--- a/spa/include/spa/graph/graph.h
+++ b/spa/include/spa/graph/graph.h
@ -30,6 +30,7 @@ extern "C" {
 #endif

 /** \defgroup spa_graph Graph
+ * Node graph
 */

 /**
--- a/spa/include/spa/param/param.h
+++ b/spa/include/spa/param/param.h
@ -30,6 +30,7 @@ extern "C" {
 #endif

 /** \defgroup spa_param Parameters
+ * Parameter value enumerations and type information
 */

 /**
--- a/spa/include/spa/pod/builder.h
+++ b/spa/include/spa/pod/builder.h
@ -30,6 +30,7 @@ extern "C" {
 #endif

 /** \defgroup spa_pod POD
+ * Binary data serialization format
 */

 /**
--- a/spa/include/spa/support/cpu.h
+++ b/spa/include/spa/support/cpu.h
@ -35,7 +35,7 @@ extern "C" {
 #include <spa/utils/hook.h>

 /** \defgroup spa_cpu CPU
- *
+ * Querying CPU properties
 */

 /**
--- a/spa/include/spa/support/dbus.h
+++ b/spa/include/spa/support/dbus.h
@ -32,7 +32,7 @@ extern "C" {
 #include <spa/support/loop.h>

 /** \defgroup spa_dbus DBus
- *
+ * DBus communication
 */

 /**
--- a/spa/include/spa/support/i18n.h
+++ b/spa/include/spa/support/i18n.h
@ -33,7 +33,7 @@ extern "C" {
 #include <spa/utils/defs.h>

 /** \defgroup spa_i18n I18N
- *
+ * Gettext interface
 */

 /**
--- a/spa/include/spa/support/log.h
+++ b/spa/include/spa/support/log.h
@ -36,6 +36,7 @@ extern "C" {
 #include <spa/utils/hook.h>

 /** \defgroup spa_log Log
+ * Logging interface
 */

 /**
--- a/spa/include/spa/support/loop.h
+++ b/spa/include/spa/support/loop.h
@ -34,7 +34,7 @@ extern "C" {
 #include <spa/support/system.h>

 /** \defgroup spa_loop Loop
- *
+ * Event loop interface
 */

 /**
--- a/spa/include/spa/support/plugin-loader.h
+++ b/spa/include/spa/support/plugin-loader.h
@ -33,7 +33,7 @@ extern "C" {
 #include <spa/utils/defs.h>

 /** \defgroup spa_plugin_loader Plugin Loader
- *
+ * SPA plugin loader
 */

 /**
--- a/spa/include/spa/support/plugin.h
+++ b/spa/include/spa/support/plugin.h
@ -34,6 +34,7 @@ extern "C" {

 /**
 * \defgroup spa_handle Plugin Handle
+ * SPA plugin handle and factory interfaces
 */

 /**
--- a/spa/include/spa/support/system.h
+++ b/spa/include/spa/support/system.h
@ -38,7 +38,7 @@ struct itimerspec;
 #include <spa/utils/hook.h>

 /** \defgroup spa_system System
- *
+ * I/O, clock, polling, timer, and signal interfaces
 */

 /**
--- a/spa/include/spa/support/thread.h
+++ b/spa/include/spa/support/thread.h
@ -37,7 +37,7 @@ extern "C" {
 #include <spa/utils/dict.h>

 /** \defgroup spa_thread Thread
- *
+ * Threading utility interfaces
 */

 /**
--- a/spa/include/spa/utils/ansi.h
+++ b/spa/include/spa/utils/ansi.h
@ -31,7 +31,7 @@ extern "C" {

 /**
 * \defgroup spa_ansi ANSI codes
- *
+ * ANSI color code macros
 */

 /**
--- a/spa/include/spa/utils/defs.h
+++ b/spa/include/spa/utils/defs.h
@ -39,7 +39,7 @@ extern "C" {

 /**
 * \defgroup spa_utils_defs Miscellaneous
- *
+ * Helper macros and functions
 */

 /**
--- a/spa/include/spa/utils/dict.h
+++ b/spa/include/spa/utils/dict.h
@ -35,7 +35,7 @@ extern "C" {

 /**
 * \defgroup spa_dict Dictionary
- *
+ * Dictionary data structure
 */

 /**
--- a/spa/include/spa/utils/json.h
+++ b/spa/include/spa/utils/json.h
@ -38,6 +38,7 @@ extern "C" {
 #include <spa/utils/defs.h>

 /** \defgroup spa_json JSON
+ * Relaxed JSON variant parsing
 */

 /**
--- a/spa/include/spa/utils/keys.h
+++ b/spa/include/spa/utils/keys.h
@ -30,6 +30,7 @@ extern "C" {
 #endif

 /** \defgroup spa_keys  Key Names
+ * Key names used by SPA plugins
 */

 /**
--- a/spa/include/spa/utils/list.h
+++ b/spa/include/spa/utils/list.h
@ -31,7 +31,7 @@ extern "C" {

 /**
 * \defgroup spa_list List
- *
+ * Doubly linked list data structure
 */

 /**
--- a/spa/include/spa/utils/names.h
+++ b/spa/include/spa/utils/names.h
@ -30,6 +30,7 @@ extern "C" {
 #endif

 /** \defgroup spa_names Factory Names
+ * SPA plugin factory names
 */

 /**
--- a/spa/include/spa/utils/result.h
+++ b/spa/include/spa/utils/result.h
@ -31,7 +31,7 @@ extern "C" {

 /**
 * \defgroup spa_result Result handling
- *
+ * Asynchronous result utilities
 */

 /**
--- a/spa/include/spa/utils/ringbuffer.h
+++ b/spa/include/spa/utils/ringbuffer.h
@ -31,7 +31,7 @@ extern "C" {

 /**
 * \defgroup spa_ringbuffer Ringbuffer
- *
+ * Ring buffer implementation
 */

 /**
--- a/spa/include/spa/utils/string.h
+++ b/spa/include/spa/utils/string.h
@ -37,7 +37,7 @@ extern "C" {

 /**
 * \defgroup spa_string String handling
- *
+ * String handling utilities
 */

 /**
--- a/spa/include/spa/utils/type.h
+++ b/spa/include/spa/utils/type.h
@ -32,6 +32,7 @@ extern "C" {
 #include <spa/utils/defs.h>

 /** \defgroup spa_types Types
+ * Data type information enumerations
 */

 /**