mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-12-16 08:56:45 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: reorganize Doxygen groups/modules to make more sense

Browse source 
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:
Pauli Virtanen 2021-10-02 20:55:53 +03:00
parent 43a84c4a2c
commit 8159797f89
95 changed files with 588 additions and 154 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/spa-pod.dox
View file

@ -1,6 +1,6 @@
/** \page page_spa_pod SPA POD
POD (plain old data) is a sort of data container. It is comparable to
\ref spa_pod (plain old data) is a sort of data container. It is comparable to
DBus Variant or LV2 Atom.
A POD can express nested structures of Objects (with properties), Vectors,
@ -519,4 +519,8 @@ field specifies the size following the type field.
Each POD is aligned to an 8 byte boundary.
\addtogroup spa_pod
See: \ref page_spa_pod
*/