From 978dbff32fe175b5c4d13922aae9b01b5504af55 Mon Sep 17 00:00:00 2001 From: Pauli Virtanen Date: Sun, 28 Jan 2024 13:06:50 +0200 Subject: [PATCH] doc: fix some doxygen warnings --- doc/dox/internals/design.dox | 2 +- doc/dox/programs/spa-acp-tool.1.md | 26 +++++++++++----------- spa/include/spa/param/audio/aac-types.h | 5 +++++ spa/include/spa/param/audio/aac.h | 5 +++++ spa/include/spa/param/audio/alac.h | 5 +++++ spa/include/spa/param/audio/amr-types.h | 5 +++++ spa/include/spa/param/audio/amr.h | 5 +++++ spa/include/spa/param/audio/ape.h | 5 +++++ spa/include/spa/param/audio/dsp.h | 5 +++++ spa/include/spa/param/audio/flac.h | 5 +++++ spa/include/spa/param/audio/iec958-types.h | 5 +++++ spa/include/spa/param/audio/mp3-types.h | 5 +++++ spa/include/spa/param/audio/mp3.h | 5 +++++ spa/include/spa/param/audio/opus.h | 5 +++++ spa/include/spa/param/audio/ra.h | 5 +++++ spa/include/spa/param/audio/vorbis.h | 5 +++++ spa/include/spa/param/audio/wma-types.h | 5 +++++ spa/include/spa/param/audio/wma.h | 5 +++++ spa/include/spa/utils/enum-types.h | 8 +++++-- src/modules/module-example-filter.c | 6 ++--- src/modules/module-filter-chain.c | 6 ++--- src/modules/module-loopback.c | 6 ++--- src/pipewire/private.h | 4 ++-- 23 files changed, 111 insertions(+), 27 deletions(-) diff --git a/doc/dox/internals/design.dox b/doc/dox/internals/design.dox index 59b29eda7..147336083 100644 --- a/doc/dox/internals/design.dox +++ b/doc/dox/internals/design.dox @@ -51,7 +51,7 @@ See \ref page_module_protocol_native for details. The functionality of the server is implemented and extended with modules and extensions. Modules are server side bits of logic that hook into various places to provide extra features. This mostly means controlling the processing -graph in some way. See \ref page_pipewire_modules for a list of current +graph in some way. See \ref page_modules for a list of current modules. Extensions are the client side version of the modules. Most extensions provide diff --git a/doc/dox/programs/spa-acp-tool.1.md b/doc/dox/programs/spa-acp-tool.1.md index 990582f84..b77f144d2 100644 --- a/doc/dox/programs/spa-acp-tool.1.md +++ b/doc/dox/programs/spa-acp-tool.1.md @@ -22,7 +22,7 @@ Show available commands \par quit | q Quit -\par card | c +\par card ID | c ID Probe card \par info | i @@ -34,40 +34,40 @@ List all objects \par list-verbose | lv List all data -\par list-profiles [id] | lpr [id] +\par list-profiles [ID] | lpr [ID] List profiles -\par set-profile | spr +\par set-profile ID | spr ID Activate a profile -\par list-ports [id] | lp [id] +\par list-ports [ID] | lp [ID] List ports -\par set-port | sp +\par set-port ID | sp ID Activate a port -\par list-devices [id] | ld [id] +\par list-devices [ID] | ld [ID] List available devices -\par get-volume | gv +\par get-volume ID | gv ID Get volume from device -\par set-volume | v +\par set-volume ID VOL | v ID VOL Set volume on device -\par inc-volume | v+ +\par inc-volume ID | v+ ID Increase volume on device -\par dec-volume | v- +\par dec-volume ID | v- ID Decrease volume on device -\par get-mute | gm +\par get-mute ID | gm ID Get mute state from device -\par set-mute | sm +\par set-mute ID VAL | sm ID VAL Set mute on device -\par toggle-mute | m +\par toggle-mute ID | m ID Toggle mute on device # AUTHORS diff --git a/spa/include/spa/param/audio/aac-types.h b/spa/include/spa/param/audio/aac-types.h index 3b8111af8..6e5047394 100644 --- a/spa/include/spa/param/audio/aac-types.h +++ b/spa/include/spa/param/audio/aac-types.h @@ -12,6 +12,11 @@ extern "C" { #include #include +/** + * \addtogroup spa_param + * \{ + */ + #define SPA_TYPE_INFO_AudioAACStreamFormat SPA_TYPE_INFO_ENUM_BASE "AudioAACStreamFormat" #define SPA_TYPE_INFO_AUDIO_AAC_STREAM_FORMAT_BASE SPA_TYPE_INFO_AudioAACStreamFormat ":" diff --git a/spa/include/spa/param/audio/aac.h b/spa/include/spa/param/audio/aac.h index b44274154..0bc1dea89 100644 --- a/spa/include/spa/param/audio/aac.h +++ b/spa/include/spa/param/audio/aac.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + enum spa_audio_aac_stream_format { SPA_AUDIO_AAC_STREAM_FORMAT_UNKNOWN, /* Raw AAC frames */ diff --git a/spa/include/spa/param/audio/alac.h b/spa/include/spa/param/audio/alac.h index 2f70222de..6e6f19fb2 100644 --- a/spa/include/spa/param/audio/alac.h +++ b/spa/include/spa/param/audio/alac.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_alac { uint32_t rate; /*< sample rate */ uint32_t channels; /*< number of channels */ diff --git a/spa/include/spa/param/audio/amr-types.h b/spa/include/spa/param/audio/amr-types.h index 1b21c5fec..9ab4c9e41 100644 --- a/spa/include/spa/param/audio/amr-types.h +++ b/spa/include/spa/param/audio/amr-types.h @@ -12,6 +12,11 @@ extern "C" { #include #include +/** + * \addtogroup spa_param + * \{ + */ + #define SPA_TYPE_INFO_AudioAMRBandMode SPA_TYPE_INFO_ENUM_BASE "AudioAMRBandMode" #define SPA_TYPE_INFO_AUDIO_AMR_BAND_MODE_BASE SPA_TYPE_INFO_AudioAMRBandMode ":" diff --git a/spa/include/spa/param/audio/amr.h b/spa/include/spa/param/audio/amr.h index f0329471d..d00125a45 100644 --- a/spa/include/spa/param/audio/amr.h +++ b/spa/include/spa/param/audio/amr.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + enum spa_audio_amr_band_mode { SPA_AUDIO_AMR_BAND_MODE_UNKNOWN, SPA_AUDIO_AMR_BAND_MODE_NB, diff --git a/spa/include/spa/param/audio/ape.h b/spa/include/spa/param/audio/ape.h index 2ea5c2ef8..03f787f53 100644 --- a/spa/include/spa/param/audio/ape.h +++ b/spa/include/spa/param/audio/ape.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_ape { uint32_t rate; /*< sample rate */ uint32_t channels; /*< number of channels */ diff --git a/spa/include/spa/param/audio/dsp.h b/spa/include/spa/param/audio/dsp.h index f33c266ae..592f25c18 100644 --- a/spa/include/spa/param/audio/dsp.h +++ b/spa/include/spa/param/audio/dsp.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_dsp { enum spa_audio_format format; /*< format, one of the DSP formats in enum spa_audio_format */ }; diff --git a/spa/include/spa/param/audio/flac.h b/spa/include/spa/param/audio/flac.h index e45745838..f213e3f83 100644 --- a/spa/include/spa/param/audio/flac.h +++ b/spa/include/spa/param/audio/flac.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_flac { uint32_t rate; /*< sample rate */ uint32_t channels; /*< number of channels */ diff --git a/spa/include/spa/param/audio/iec958-types.h b/spa/include/spa/param/audio/iec958-types.h index 3d52da4ca..6388a24f1 100644 --- a/spa/include/spa/param/audio/iec958-types.h +++ b/spa/include/spa/param/audio/iec958-types.h @@ -12,6 +12,11 @@ extern "C" { #include #include +/** + * \addtogroup spa_param + * \{ + */ + #define SPA_TYPE_INFO_AudioIEC958Codec SPA_TYPE_INFO_ENUM_BASE "AudioIEC958Codec" #define SPA_TYPE_INFO_AUDIO_IEC958_CODEC_BASE SPA_TYPE_INFO_AudioIEC958Codec ":" diff --git a/spa/include/spa/param/audio/mp3-types.h b/spa/include/spa/param/audio/mp3-types.h index 62be6eb6d..a7ba22ace 100644 --- a/spa/include/spa/param/audio/mp3-types.h +++ b/spa/include/spa/param/audio/mp3-types.h @@ -12,6 +12,11 @@ extern "C" { #include #include +/** + * \addtogroup spa_param + * \{ + */ + #define SPA_TYPE_INFO_AudioMP3ChannelMode SPA_TYPE_INFO_ENUM_BASE "AudioMP3ChannelMode" #define SPA_TYPE_INFO_AUDIO_MP3_CHANNEL_MODE_BASE SPA_TYPE_INFO_AudioMP3ChannelMode ":" diff --git a/spa/include/spa/param/audio/mp3.h b/spa/include/spa/param/audio/mp3.h index 6543819a8..86be21a1e 100644 --- a/spa/include/spa/param/audio/mp3.h +++ b/spa/include/spa/param/audio/mp3.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + enum spa_audio_mp3_channel_mode { SPA_AUDIO_MP3_CHANNEL_MODE_UNKNOWN, SPA_AUDIO_MP3_CHANNEL_MODE_MONO, diff --git a/spa/include/spa/param/audio/opus.h b/spa/include/spa/param/audio/opus.h index f27dc6306..cdd0e6c5b 100644 --- a/spa/include/spa/param/audio/opus.h +++ b/spa/include/spa/param/audio/opus.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_opus { uint32_t rate; /*< sample rate */ uint32_t channels; /*< number of channels */ diff --git a/spa/include/spa/param/audio/ra.h b/spa/include/spa/param/audio/ra.h index 3dba2919f..b784ab588 100644 --- a/spa/include/spa/param/audio/ra.h +++ b/spa/include/spa/param/audio/ra.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_ra { uint32_t rate; /*< sample rate */ uint32_t channels; /*< number of channels */ diff --git a/spa/include/spa/param/audio/vorbis.h b/spa/include/spa/param/audio/vorbis.h index c18f7eefa..e3ab490ef 100644 --- a/spa/include/spa/param/audio/vorbis.h +++ b/spa/include/spa/param/audio/vorbis.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + struct spa_audio_info_vorbis { uint32_t rate; /*< sample rate */ uint32_t channels; /*< number of channels */ diff --git a/spa/include/spa/param/audio/wma-types.h b/spa/include/spa/param/audio/wma-types.h index 45ca104e6..40f9d6682 100644 --- a/spa/include/spa/param/audio/wma-types.h +++ b/spa/include/spa/param/audio/wma-types.h @@ -12,6 +12,11 @@ extern "C" { #include #include +/** + * \addtogroup spa_param + * \{ + */ + #define SPA_TYPE_INFO_AudioWMAProfile SPA_TYPE_INFO_ENUM_BASE "AudioWMAProfile" #define SPA_TYPE_INFO_AUDIO_WMA_PROFILE_BASE SPA_TYPE_INFO_AudioWMAProfile ":" diff --git a/spa/include/spa/param/audio/wma.h b/spa/include/spa/param/audio/wma.h index 1bbcafe02..dd1e53a86 100644 --- a/spa/include/spa/param/audio/wma.h +++ b/spa/include/spa/param/audio/wma.h @@ -11,6 +11,11 @@ extern "C" { #include +/** + * \addtogroup spa_param + * \{ + */ + enum spa_audio_wma_profile { SPA_AUDIO_WMA_PROFILE_UNKNOWN, diff --git a/spa/include/spa/utils/enum-types.h b/spa/include/spa/utils/enum-types.h index 5be467e61..881ffd8b3 100644 --- a/spa/include/spa/utils/enum-types.h +++ b/spa/include/spa/utils/enum-types.h @@ -10,6 +10,12 @@ extern "C" { #endif #include +#include + +/** + * \addtogroup spa_types + * \{ + */ #define SPA_TYPE_INFO_Direction SPA_TYPE_INFO_ENUM_BASE "Direction" #define SPA_TYPE_INFO_DIRECTION_BASE SPA_TYPE_INFO_Direction ":" @@ -20,8 +26,6 @@ static const struct spa_type_info spa_type_direction[] = { { 0, 0, NULL, NULL } }; -#include - #define SPA_TYPE_INFO_Choice SPA_TYPE_INFO_ENUM_BASE "Choice" #define SPA_TYPE_INFO_CHOICE_BASE SPA_TYPE_INFO_Choice ":" diff --git a/src/modules/module-example-filter.c b/src/modules/module-example-filter.c index 3de26caef..5b6de4b9c 100644 --- a/src/modules/module-example-filter.c +++ b/src/modules/module-example-filter.c @@ -52,13 +52,13 @@ * - \ref PW_KEY_NODE_GROUP * - \ref PW_KEY_NODE_LINK_GROUP * - \ref PW_KEY_NODE_VIRTUAL - * - \ref PW_KEY_NODE_NAME: See notes below. If not specified, defaults to - * 'filter--'. + * - \ref PW_KEY_NODE_NAME : See notes below. If not specified, defaults to + * 'filter-PID-MODULEID'. * * Stream only properties: * * - \ref PW_KEY_MEDIA_CLASS - * - \ref PW_KEY_NODE_NAME: if not given per stream, the global node.name will be + * - \ref PW_KEY_NODE_NAME : if not given per stream, the global node.name will be * prefixed with 'input.' and 'output.' to generate a capture and playback * stream node.name respectively. * diff --git a/src/modules/module-filter-chain.c b/src/modules/module-filter-chain.c index 1022f0650..94e7a0157 100644 --- a/src/modules/module-filter-chain.c +++ b/src/modules/module-filter-chain.c @@ -461,13 +461,13 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); * - \ref PW_KEY_NODE_GROUP * - \ref PW_KEY_NODE_LINK_GROUP * - \ref PW_KEY_NODE_VIRTUAL - * - \ref PW_KEY_NODE_NAME: See notes below. If not specified, defaults to - * 'filter-chain--'. + * - \ref PW_KEY_NODE_NAME : See notes below. If not specified, defaults to + * 'filter-chain-PID-MODULEID'. * * Stream only properties: * * - \ref PW_KEY_MEDIA_CLASS - * - \ref PW_KEY_NODE_NAME: if not given per stream, the global node.name will be + * - \ref PW_KEY_NODE_NAME : if not given per stream, the global node.name will be * prefixed with 'input.' and 'output.' to generate a capture and playback * stream node.name respectively. * diff --git a/src/modules/module-loopback.c b/src/modules/module-loopback.c index 91c764edf..2ebaccaca 100644 --- a/src/modules/module-loopback.c +++ b/src/modules/module-loopback.c @@ -57,13 +57,13 @@ * - \ref PW_KEY_NODE_GROUP * - \ref PW_KEY_NODE_LINK_GROUP * - \ref PW_KEY_NODE_VIRTUAL - * - \ref PW_KEY_NODE_NAME: See notes below. If not specified, defaults to - * 'loopback--'. + * - \ref PW_KEY_NODE_NAME : See notes below. If not specified, defaults to + * 'loopback-PID-MODULEID'. * * Stream only properties: * * - \ref PW_KEY_MEDIA_CLASS - * - \ref PW_KEY_NODE_NAME: if not given per stream, the global node.name will be + * - \ref PW_KEY_NODE_NAME : if not given per stream, the global node.name will be * prefixed with 'input.' and 'output.' to generate a capture and playback * stream node.name respectively. * diff --git a/src/pipewire/private.h b/src/pipewire/private.h index aa077bd6f..c761a57bb 100644 --- a/src/pipewire/private.h +++ b/src/pipewire/private.h @@ -5,6 +5,8 @@ #ifndef PIPEWIRE_PRIVATE_H #define PIPEWIRE_PRIVATE_H +/** \privatesection */ + #ifdef __cplusplus extern "C" { #endif @@ -1298,8 +1300,6 @@ bool pw_should_dlclose(void); void pw_log_topic_register_enum(const struct spa_log_topic_enum *e); void pw_log_topic_unregister_enum(const struct spa_log_topic_enum *e); -/** \endcond */ - #ifdef __cplusplus } #endif