mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2026-03-06 01:40:26 -05:00
doc: reorganize Doxygen groups/modules to make more sense
The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
This commit is contained in:
parent
43a84c4a2c
commit
8159797f89
95 changed files with 588 additions and 154 deletions
|
|
@ -34,6 +34,14 @@ extern "C" {
|
|||
|
||||
#include <pipewire/proxy.h>
|
||||
|
||||
/** \defgroup pw_module Module
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup pw_module
|
||||
* \{
|
||||
*/
|
||||
#define PW_TYPE_INTERFACE_Module PW_TYPE_INFO_INTERFACE_BASE "Module"
|
||||
|
||||
#define PW_VERSION_MODULE 3
|
||||
|
|
@ -102,6 +110,10 @@ struct pw_module_methods {
|
|||
|
||||
#define pw_module_add_listener(c,...) pw_module_method(c,add_listener,0,__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue