mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: fix some doxygen warnings

Browse source
This commit is contained in:
Pauli Virtanen 2024-01-28 13:06:50 +02:00 • committed by Wim Taymans
parent 8e3c0f02b2
commit 978dbff32f
23 changed files with 111 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/dox/internals/design.dox
View file

@ -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

26
doc/dox/programs/spa-acp-tool.1.md
View file

@ -22,7 +22,7 @@ Show available commands
\par quit | q
Quit
\par card <id> | c <id>
\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 <id> | spr <id>
\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 <id> | sp <id>
\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 <id> | gv <id>
\par get-volume ID | gv ID
Get volume from device
\par set-volume <id> <vol> | v <id> <vol>
\par set-volume ID VOL | v ID VOL
Set volume on device
\par inc-volume <id> | v+ <id>
\par inc-volume ID | v+ ID
Increase volume on device
\par dec-volume <id> | v- <id>
\par dec-volume ID | v- ID
Decrease volume on device
\par get-mute <id> | gm <id>
\par get-mute ID | gm ID
Get mute state from device
\par set-mute <id> <val> | sm <id> <val>
\par set-mute ID VAL | sm ID VAL
Set mute on device
\par toggle-mute <id> | m <id>
\par toggle-mute ID | m ID
Toggle mute on device
# AUTHORS

5
spa/include/spa/param/audio/aac-types.h
View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/aac.h>
/**
* \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 ":"

5
spa/include/spa/param/audio/aac.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_aac_stream_format {
SPA_AUDIO_AAC_STREAM_FORMAT_UNKNOWN,
/* Raw AAC frames */

5
spa/include/spa/param/audio/alac.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_alac {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

5
spa/include/spa/param/audio/amr-types.h
View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/amr.h>
/**
* \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 ":"

5
spa/include/spa/param/audio/amr.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_amr_band_mode {
SPA_AUDIO_AMR_BAND_MODE_UNKNOWN,
SPA_AUDIO_AMR_BAND_MODE_NB,

5
spa/include/spa/param/audio/ape.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_ape {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

5
spa/include/spa/param/audio/dsp.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_dsp {
enum spa_audio_format format; /*< format, one of the DSP formats in enum spa_audio_format */
};

5
spa/include/spa/param/audio/flac.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_flac {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

5
spa/include/spa/param/audio/iec958-types.h
View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/iec958.h>
/**
* \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 ":"

5
spa/include/spa/param/audio/mp3-types.h
View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/mp3.h>
/**
* \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 ":"

5
spa/include/spa/param/audio/mp3.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_mp3_channel_mode {
SPA_AUDIO_MP3_CHANNEL_MODE_UNKNOWN,
SPA_AUDIO_MP3_CHANNEL_MODE_MONO,

5
spa/include/spa/param/audio/opus.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_opus {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

5
spa/include/spa/param/audio/ra.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_ra {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

5
spa/include/spa/param/audio/vorbis.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
struct spa_audio_info_vorbis {
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */

5
spa/include/spa/param/audio/wma-types.h
View file

@ -12,6 +12,11 @@ extern "C" {
#include <spa/utils/type.h>
#include <spa/param/audio/wma.h>
/**
* \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 ":"

5
spa/include/spa/param/audio/wma.h
View file

@ -11,6 +11,11 @@ extern "C" {
#include <spa/param/audio/raw.h>
/**
* \addtogroup spa_param
* \{
*/
enum spa_audio_wma_profile {
SPA_AUDIO_WMA_PROFILE_UNKNOWN,

8
spa/include/spa/utils/enum-types.h
View file

@ -10,6 +10,12 @@ extern "C" {
#endif
#include <spa/utils/type.h>
#include <spa/pod/pod.h>
/**
* \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 <spa/pod/pod.h>
#define SPA_TYPE_INFO_Choice SPA_TYPE_INFO_ENUM_BASE "Choice"
#define SPA_TYPE_INFO_CHOICE_BASE SPA_TYPE_INFO_Choice ":"

6
src/modules/module-example-filter.c
View file

@ -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-<pid>-<module-id>'.
* - \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.
*

6
src/modules/module-filter-chain.c
View file

@ -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-<pid>-<module-id>'.
* - \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.
*

6
src/modules/module-loopback.c
View file

@ -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-<pid>-<module-id>'.
* - \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.
*

4
src/pipewire/private.h
View file

@ -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