doc: add brief explanations for all groups

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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