mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-01 22:58:50 -04:00
doc: add brief explanations for all groups
This commit is contained in:
parent
125051a700
commit
49901f2d61
44 changed files with 46 additions and 31 deletions
|
|
@ -35,6 +35,7 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/** \defgroup pw_buffers Buffers
|
||||
* Buffer handling
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ extern "C" {
|
|||
#include <pipewire/permission.h>
|
||||
|
||||
/** \defgroup pw_client Client
|
||||
*
|
||||
* Client interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
#include <pipewire/context.h>
|
||||
|
||||
/** \defgroup pw_conf Configuration
|
||||
*
|
||||
* Loading/saving properties from/to configuration files.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ extern "C" {
|
|||
#include <pipewire/proxy.h>
|
||||
|
||||
/** \defgroup pw_device Device
|
||||
*
|
||||
* Device interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ extern "C" {
|
|||
#include <spa/param/param.h>
|
||||
|
||||
/** \defgroup pw_client_node Client Node
|
||||
*
|
||||
* Client node interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
|
||||
/** \defgroup pw_metadata Metadata
|
||||
*
|
||||
* Metadata interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
|
||||
/** \defgroup pw_profiler Profiler
|
||||
*
|
||||
* Profiler interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ extern "C" {
|
|||
#include <pipewire/resource.h>
|
||||
|
||||
/** \defgroup pw_protocol_native Native Protocol
|
||||
*
|
||||
* PipeWire native protocol interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
#define PIPEWIRE_EXT_SESSION_MANAGER_H
|
||||
|
||||
/** \defgroup pw_session_manager Session Manager
|
||||
*
|
||||
* Session manager interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ extern "C" {
|
|||
#include <pipewire/proxy.h>
|
||||
|
||||
/** \defgroup pw_factory Factory
|
||||
*
|
||||
* Factory interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/** \defgroup pw_gettext Internationalization
|
||||
*
|
||||
* Gettext interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/** \defgroup pw_memblock Memory Blocks
|
||||
*
|
||||
* Memory allocation and pools.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ extern "C" {
|
|||
#include <pipewire/proxy.h>
|
||||
|
||||
/** \defgroup pw_module Module
|
||||
*
|
||||
* Module interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ extern "C" {
|
|||
#include <pipewire/proxy.h>
|
||||
|
||||
/** \defgroup pw_node Node
|
||||
*
|
||||
* Node interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@ extern "C" {
|
|||
#include <pipewire/version.h>
|
||||
|
||||
/** \defgroup pw_pipewire Initialization
|
||||
* Initializing PipeWire and loading SPA modules.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ extern "C" {
|
|||
#include <pipewire/proxy.h>
|
||||
|
||||
/** \defgroup pw_port Port
|
||||
*
|
||||
* Port interface
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -31,7 +31,8 @@ extern "C" {
|
|||
|
||||
#include <spa/utils/type.h>
|
||||
|
||||
/** \defgroup pw_type Type
|
||||
/** \defgroup pw_type Type info
|
||||
* Type information
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -30,6 +30,7 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/** \defgroup pw_work_queue Work Queue
|
||||
* Queued processing of work items.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue