mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-31 22:25:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add brief explanations for all groups

Browse source
This commit is contained in:
Pauli Virtanen 2021-10-04 00:00:41 +03:00
parent 125051a700
commit 49901f2d61
44 changed files with 46 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/api-tree.dox
View file

@ -80,6 +80,7 @@
\addtogroup spa_param \addtogroup spa_param
\addtogroup spa_pod \addtogroup spa_pod
\defgroup spa_utils Utilities \defgroup spa_utils Utilities
Utility data structures, macros, etc.
\{ \{
\addtogroup spa_ansi \addtogroup spa_ansi
\addtogroup spa_utils_defs \addtogroup spa_utils_defs
@ -96,6 +97,7 @@
\addtogroup spa_types \addtogroup spa_types
\} \}
\defgroup spa_support Support \defgroup spa_support Support
Support interfaces provided by host
\{ \{
\addtogroup spa_cpu \addtogroup spa_cpu
\addtogroup spa_dbus \addtogroup spa_dbus

2
spa/include/spa/control/control.h
View file

@ -33,7 +33,7 @@ extern "C" {
#include <spa/pod/pod.h> #include <spa/pod/pod.h>
/** \defgroup spa_control Control /** \defgroup spa_control Control
* * Control type declarations
*/ */
/** /**

2
spa/include/spa/debug/buffer.h
View file

@ -30,7 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup spa_debug Debug /** \defgroup spa_debug Debug
* * Debugging utilities
*/ */
/** /**

1
spa/include/spa/graph/graph.h
View file

@ -30,6 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup spa_graph Graph /** \defgroup spa_graph Graph
* Node graph
*/ */
/** /**

1
spa/include/spa/param/param.h
View file

@ -30,6 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup spa_param Parameters /** \defgroup spa_param Parameters
* Parameter value enumerations and type information
*/ */
/** /**

1
spa/include/spa/pod/builder.h
View file

@ -30,6 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup spa_pod POD /** \defgroup spa_pod POD
* Binary data serialization format
*/ */
/** /**

2
spa/include/spa/support/cpu.h
View file

@ -35,7 +35,7 @@ extern "C" {
#include <spa/utils/hook.h> #include <spa/utils/hook.h>
/** \defgroup spa_cpu CPU /** \defgroup spa_cpu CPU
* * Querying CPU properties
*/ */
/** /**

2
spa/include/spa/support/dbus.h
View file

@ -32,7 +32,7 @@ extern "C" {
#include <spa/support/loop.h> #include <spa/support/loop.h>
/** \defgroup spa_dbus DBus /** \defgroup spa_dbus DBus
* * DBus communication
*/ */
/** /**

2
spa/include/spa/support/i18n.h
View file

@ -33,7 +33,7 @@ extern "C" {
#include <spa/utils/defs.h> #include <spa/utils/defs.h>
/** \defgroup spa_i18n I18N /** \defgroup spa_i18n I18N
* * Gettext interface
*/ */
/** /**

1
spa/include/spa/support/log.h
View file

@ -36,6 +36,7 @@ extern "C" {
#include <spa/utils/hook.h> #include <spa/utils/hook.h>
/** \defgroup spa_log Log /** \defgroup spa_log Log
* Logging interface
*/ */
/** /**

2
spa/include/spa/support/loop.h
View file

@ -34,7 +34,7 @@ extern "C" {
#include <spa/support/system.h> #include <spa/support/system.h>
/** \defgroup spa_loop Loop /** \defgroup spa_loop Loop
* * Event loop interface
*/ */
/** /**

2
spa/include/spa/support/plugin-loader.h
View file

@ -33,7 +33,7 @@ extern "C" {
#include <spa/utils/defs.h> #include <spa/utils/defs.h>
/** \defgroup spa_plugin_loader Plugin Loader /** \defgroup spa_plugin_loader Plugin Loader
* * SPA plugin loader
*/ */
/** /**

1
spa/include/spa/support/plugin.h
View file

@ -34,6 +34,7 @@ extern "C" {
/** /**
* \defgroup spa_handle Plugin Handle * \defgroup spa_handle Plugin Handle
* SPA plugin handle and factory interfaces
*/ */
/** /**

2
spa/include/spa/support/system.h
View file

@ -38,7 +38,7 @@ struct itimerspec;
#include <spa/utils/hook.h> #include <spa/utils/hook.h>
/** \defgroup spa_system System /** \defgroup spa_system System
* * I/O, clock, polling, timer, and signal interfaces
*/ */
/** /**

2
spa/include/spa/support/thread.h
View file

@ -37,7 +37,7 @@ extern "C" {
#include <spa/utils/dict.h> #include <spa/utils/dict.h>
/** \defgroup spa_thread Thread /** \defgroup spa_thread Thread
* * Threading utility interfaces
*/ */
/** /**

2
spa/include/spa/utils/ansi.h
View file

@ -31,7 +31,7 @@ extern "C" {
/** /**
* \defgroup spa_ansi ANSI codes * \defgroup spa_ansi ANSI codes
* * ANSI color code macros
*/ */
/** /**

2
spa/include/spa/utils/defs.h
View file

@ -39,7 +39,7 @@ extern "C" {
/** /**
* \defgroup spa_utils_defs Miscellaneous * \defgroup spa_utils_defs Miscellaneous
* * Helper macros and functions
*/ */
/** /**

2
spa/include/spa/utils/dict.h
View file

@ -35,7 +35,7 @@ extern "C" {
/** /**
* \defgroup spa_dict Dictionary * \defgroup spa_dict Dictionary
* * Dictionary data structure
*/ */
/** /**

1
spa/include/spa/utils/json.h
View file

@ -38,6 +38,7 @@ extern "C" {
#include <spa/utils/defs.h> #include <spa/utils/defs.h>
/** \defgroup spa_json JSON /** \defgroup spa_json JSON
* Relaxed JSON variant parsing
*/ */
/** /**

1
spa/include/spa/utils/keys.h
View file

@ -30,6 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup spa_keys Key Names /** \defgroup spa_keys Key Names
* Key names used by SPA plugins
*/ */
/** /**

2
spa/include/spa/utils/list.h
View file

@ -31,7 +31,7 @@ extern "C" {
/** /**
* \defgroup spa_list List * \defgroup spa_list List
* * Doubly linked list data structure
*/ */
/** /**

1
spa/include/spa/utils/names.h
View file

@ -30,6 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup spa_names Factory Names /** \defgroup spa_names Factory Names
* SPA plugin factory names
*/ */
/** /**

2
spa/include/spa/utils/result.h
View file

@ -31,7 +31,7 @@ extern "C" {
/** /**
* \defgroup spa_result Result handling * \defgroup spa_result Result handling
* * Asynchronous result utilities
*/ */
/** /**

2
spa/include/spa/utils/ringbuffer.h
View file

@ -31,7 +31,7 @@ extern "C" {
/** /**
* \defgroup spa_ringbuffer Ringbuffer * \defgroup spa_ringbuffer Ringbuffer
* * Ring buffer implementation
*/ */
/** /**

2
spa/include/spa/utils/string.h
View file

@ -37,7 +37,7 @@ extern "C" {
/** /**
* \defgroup spa_string String handling * \defgroup spa_string String handling
* * String handling utilities
*/ */
/** /**

1
spa/include/spa/utils/type.h
View file

@ -32,6 +32,7 @@ extern "C" {
#include <spa/utils/defs.h> #include <spa/utils/defs.h>
/** \defgroup spa_types Types /** \defgroup spa_types Types
* Data type information enumerations
*/ */
/** /**

1
src/pipewire/buffers.h
View file

@ -35,6 +35,7 @@ extern "C" {
#endif #endif
/** \defgroup pw_buffers Buffers /** \defgroup pw_buffers Buffers
* Buffer handling
*/ */
/** /**

2
src/pipewire/client.h
View file

@ -36,7 +36,7 @@ extern "C" {
#include <pipewire/permission.h> #include <pipewire/permission.h>
/** \defgroup pw_client Client /** \defgroup pw_client Client
* * Client interface
*/ */
/** /**

2
src/pipewire/conf.h
View file

@ -25,7 +25,7 @@
#include <pipewire/context.h> #include <pipewire/context.h>
/** \defgroup pw_conf Configuration /** \defgroup pw_conf Configuration
* * Loading/saving properties from/to configuration files.
*/ */
/** /**

2
src/pipewire/device.h
View file

@ -35,7 +35,7 @@ extern "C" {
#include <pipewire/proxy.h> #include <pipewire/proxy.h>
/** \defgroup pw_device Device /** \defgroup pw_device Device
* * Device interface
*/ */
/** /**

2
src/pipewire/extensions/client-node.h
View file

@ -33,7 +33,7 @@ extern "C" {
#include <spa/param/param.h> #include <spa/param/param.h>
/** \defgroup pw_client_node Client Node /** \defgroup pw_client_node Client Node
* * Client node interface
*/ */
/** /**

2
src/pipewire/extensions/metadata.h
View file

@ -32,7 +32,7 @@ extern "C" {
#include <spa/utils/defs.h> #include <spa/utils/defs.h>
/** \defgroup pw_metadata Metadata /** \defgroup pw_metadata Metadata
* * Metadata interface
*/ */
/** /**

2
src/pipewire/extensions/profiler.h
View file

@ -32,7 +32,7 @@ extern "C" {
#include <spa/utils/defs.h> #include <spa/utils/defs.h>
/** \defgroup pw_profiler Profiler /** \defgroup pw_profiler Profiler
* * Profiler interface
*/ */
/** /**

2
src/pipewire/extensions/protocol-native.h
View file

@ -35,7 +35,7 @@ extern "C" {
#include <pipewire/resource.h> #include <pipewire/resource.h>
/** \defgroup pw_protocol_native Native Protocol /** \defgroup pw_protocol_native Native Protocol
* * PipeWire native protocol interface
*/ */
/** /**

2
src/pipewire/extensions/session-manager.h
View file

@ -27,7 +27,7 @@
#define PIPEWIRE_EXT_SESSION_MANAGER_H #define PIPEWIRE_EXT_SESSION_MANAGER_H
/** \defgroup pw_session_manager Session Manager /** \defgroup pw_session_manager Session Manager
* * Session manager interface
*/ */
/** /**

2
src/pipewire/factory.h
View file

@ -38,7 +38,7 @@ extern "C" {
#include <pipewire/proxy.h> #include <pipewire/proxy.h>
/** \defgroup pw_factory Factory /** \defgroup pw_factory Factory
* * Factory interface
*/ */
/** /**

2
src/pipewire/i18n.h
View file

@ -30,7 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup pw_gettext Internationalization /** \defgroup pw_gettext Internationalization
* * Gettext interface
*/ */
/** /**

2
src/pipewire/mem.h
View file

@ -32,7 +32,7 @@ extern "C" {
#endif #endif
/** \defgroup pw_memblock Memory Blocks /** \defgroup pw_memblock Memory Blocks
* * Memory allocation and pools.
*/ */
/** /**

2
src/pipewire/module.h
View file

@ -35,7 +35,7 @@ extern "C" {
#include <pipewire/proxy.h> #include <pipewire/proxy.h>
/** \defgroup pw_module Module /** \defgroup pw_module Module
* * Module interface
*/ */
/** /**

2
src/pipewire/node.h
View file

@ -40,7 +40,7 @@ extern "C" {
#include <pipewire/proxy.h> #include <pipewire/proxy.h>
/** \defgroup pw_node Node /** \defgroup pw_node Node
* * Node interface
*/ */
/** /**

1
src/pipewire/pipewire.h
View file

@ -61,6 +61,7 @@ extern "C" {
#include <pipewire/version.h> #include <pipewire/version.h>
/** \defgroup pw_pipewire Initialization /** \defgroup pw_pipewire Initialization
* Initializing PipeWire and loading SPA modules.
*/ */
/** /**

2
src/pipewire/port.h
View file

@ -39,7 +39,7 @@ extern "C" {
#include <pipewire/proxy.h> #include <pipewire/proxy.h>
/** \defgroup pw_port Port /** \defgroup pw_port Port
* * Port interface
*/ */
/** /**

3
src/pipewire/type.h
View file

@ -31,7 +31,8 @@ extern "C" {
#include <spa/utils/type.h> #include <spa/utils/type.h>
/** \defgroup pw_type Type /** \defgroup pw_type Type info
* Type information
*/ */
/** /**

1
src/pipewire/work-queue.h
View file

@ -30,6 +30,7 @@ extern "C" {
#endif #endif
/** \defgroup pw_work_queue Work Queue /** \defgroup pw_work_queue Work Queue
* Queued processing of work items.
*/ */
/** /**