Commit 49901f2d authored by P V's avatar P V
Browse files

doc: add brief explanations for all groups

parent 125051a7
......@@ -80,6 +80,7 @@
\addtogroup spa_param
\addtogroup spa_pod
\defgroup spa_utils Utilities
Utility data structures, macros, etc.
\{
\addtogroup spa_ansi
\addtogroup spa_utils_defs
......@@ -96,6 +97,7 @@
\addtogroup spa_types
\}
\defgroup spa_support Support
Support interfaces provided by host
\{
\addtogroup spa_cpu
\addtogroup spa_dbus
......
......@@ -33,7 +33,7 @@ extern "C" {
#include <spa/pod/pod.h>
/** \defgroup spa_control Control
*
* Control type declarations
*/
/**
......
......@@ -30,7 +30,7 @@ extern "C" {
#endif
/** \defgroup spa_debug Debug
*
* Debugging utilities
*/
/**
......
......@@ -30,6 +30,7 @@ extern "C" {
#endif
/** \defgroup spa_graph Graph
* Node graph
*/
/**
......
......@@ -30,6 +30,7 @@ extern "C" {
#endif
/** \defgroup spa_param Parameters
* Parameter value enumerations and type information
*/
/**
......
......@@ -30,6 +30,7 @@ extern "C" {
#endif
/** \defgroup spa_pod POD
* Binary data serialization format
*/
/**
......
......@@ -35,7 +35,7 @@ extern "C" {
#include <spa/utils/hook.h>
/** \defgroup spa_cpu CPU
*
* Querying CPU properties
*/
/**
......
......@@ -32,7 +32,7 @@ extern "C" {
#include <spa/support/loop.h>
/** \defgroup spa_dbus DBus
*
* DBus communication
*/
/**
......
......@@ -33,7 +33,7 @@ extern "C" {
#include <spa/utils/defs.h>
/** \defgroup spa_i18n I18N
*
* Gettext interface
*/
/**
......
......@@ -36,6 +36,7 @@ extern "C" {
#include <spa/utils/hook.h>
/** \defgroup spa_log Log
* Logging interface
*/
/**
......
......@@ -34,7 +34,7 @@ extern "C" {
#include <spa/support/system.h>
/** \defgroup spa_loop Loop
*
* Event loop interface
*/
/**
......
......@@ -33,7 +33,7 @@ extern "C" {
#include <spa/utils/defs.h>
/** \defgroup spa_plugin_loader Plugin Loader
*
* SPA plugin loader
*/
/**
......
......@@ -34,6 +34,7 @@ extern "C" {
/**
* \defgroup spa_handle Plugin Handle
* SPA plugin handle and factory interfaces
*/
/**
......
......@@ -38,7 +38,7 @@ struct itimerspec;
#include <spa/utils/hook.h>
/** \defgroup spa_system System
*
* I/O, clock, polling, timer, and signal interfaces
*/
/**
......
......@@ -37,7 +37,7 @@ extern "C" {
#include <spa/utils/dict.h>
/** \defgroup spa_thread Thread
*
* Threading utility interfaces
*/
/**
......
......@@ -31,7 +31,7 @@ extern "C" {
/**
* \defgroup spa_ansi ANSI codes
*
* ANSI color code macros
*/
/**
......
......@@ -39,7 +39,7 @@ extern "C" {
/**
* \defgroup spa_utils_defs Miscellaneous
*
* Helper macros and functions
*/
/**
......
......@@ -35,7 +35,7 @@ extern "C" {
/**
* \defgroup spa_dict Dictionary
*
* Dictionary data structure
*/
/**
......
......@@ -38,6 +38,7 @@ extern "C" {
#include <spa/utils/defs.h>
/** \defgroup spa_json JSON
* Relaxed JSON variant parsing
*/
/**
......
......@@ -30,6 +30,7 @@ extern "C" {
#endif
/** \defgroup spa_keys Key Names
* Key names used by SPA plugins
*/
/**
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment