mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2026-02-24 01:40:20 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: switch doxygen to using groups instead of pages and classes

Browse source 
C code doesn't lend itself well to using classes and pages are best for prose.
A doxygen group is a set of related functions - which is exactly what we have
here, e.g. pw_context.

This patch basically adds the following lines to each header:
\defgroup pw_whatever
\addtogroup pw_whatever
\{
....  function declarations ....
\}

Doxygen is smart enough to merge documentation in the header with
documentation in the correspondin .c file where the function is implemented.
This commit is contained in:
Peter Hutterer 2021-05-20 19:47:13 +10:00
parent 4cf18c92f8
commit cbe29c070c
52 changed files with 546 additions and 327 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/pipewire/module.h
View file

@ -39,7 +39,7 @@ extern "C" {
#define PW_VERSION_MODULE 3
struct pw_module;
/** The module information. Extra information can be added in later versions \memberof pw_introspect */
/** The module information. Extra information can be added in later versions */
struct pw_module_info {
uint32_t id; /**< id of the global */
const char *name; /**< name of the module */
@ -51,12 +51,12 @@ struct pw_module_info {
struct spa_dict *props; /**< extra properties */
};
/** Update and existing \ref pw_module_info with \a update \memberof pw_introspect */
/** Update and existing \ref pw_module_info with \a update */
struct pw_module_info *
pw_module_info_update(struct pw_module_info *info,
const struct pw_module_info *update);
/** Free a \ref pw_module_info \memberof pw_introspect */
/** Free a \ref pw_module_info */
void pw_module_info_free(struct pw_module_info *info);
#define PW_MODULE_EVENT_INFO 0