mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-25 06:59:57 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: make the pipewire keys show up in the doxygen output

Browse source
This commit is contained in:
Peter Hutterer 2021-06-24 14:26:21 +10:00 • committed by Wim Taymans
parent f181232a61
commit b23dfc4dc1
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/pipewire/keys.h
View file

@ -30,6 +30,8 @@ extern "C" {
#endif #endif
/** /**
* \defgroup pw_keys PipeWire Keys
*
* A collection of keys that are used to add extra information on objects. * A collection of keys that are used to add extra information on objects.
* *
* Keys that start with "pipewire." are in general set-once and then * Keys that start with "pipewire." are in general set-once and then
@ -38,6 +40,9 @@ extern "C" {
* *
* Properties from other objects can also appear. This usually suggests some * Properties from other objects can also appear. This usually suggests some
* sort of parent/child or owner/owned relationship. * sort of parent/child or owner/owned relationship.
*
* \addtogroup pw_keys
* \{
*/ */
#define PW_KEY_PROTOCOL "pipewire.protocol" /**< protocol used for connection */ #define PW_KEY_PROTOCOL "pipewire.protocol" /**< protocol used for connection */
#define PW_KEY_ACCESS "pipewire.access" /**< how the client access is controlled */ #define PW_KEY_ACCESS "pipewire.access" /**< how the client access is controlled */
@ -299,6 +304,9 @@ extern "C" {
#define PW_KEY_PRIORITY_MASTER "priority.master" /**< deprecated */ #define PW_KEY_PRIORITY_MASTER "priority.master" /**< deprecated */
#endif /* PW_ENABLE_DEPRECATED */ #endif /* PW_ENABLE_DEPRECATED */
/** \}
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif