From f055949cb5d88ea7e943f49f964291476cf7abe2 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Fri, 26 Jun 2026 12:41:02 +0200 Subject: [PATCH] docs: fix broken doxygen references and escape HTML tags - modules.dox: remove references to non-existent sendspin modules - access.dox: remove reference to deprecated pipewire-media-session - dma-buf.dox: fix \ref EnumFormat to \ref SPA_PARAM_EnumFormat, fix \ref struct to struct \ref for spa_meta_sync_timeline - pipewire.conf.5.md: add explicit {#synopsis} anchor for internal links - pipewire-client.conf.5.md: fix audio_converter to audio_adapter ref - pipewire-jack.conf.5.md: escape HTML tags - pipewire-props.7.md: fix monitor-prop__ to props__ for card profiles ref - pipewire-pulse.1.md: fix pipewire-env ref to full anchor name - pipewire.1.md: fix \ref CPU to \ref spa_cpu Co-Authored-By: Claude Opus 4.6 --- doc/dox/config/pipewire-client.conf.5.md | 2 +- doc/dox/config/pipewire-jack.conf.5.md | 4 ++-- doc/dox/config/pipewire-props.7.md | 2 +- doc/dox/config/pipewire.conf.5.md | 2 +- doc/dox/internals/access.dox | 3 --- doc/dox/internals/dma-buf.dox | 10 +++++----- doc/dox/programs/pipewire-pulse.1.md | 2 +- doc/dox/programs/pipewire.1.md | 4 ++-- src/modules/meson.build | 2 ++ 9 files changed, 15 insertions(+), 16 deletions(-) diff --git a/doc/dox/config/pipewire-client.conf.5.md b/doc/dox/config/pipewire-client.conf.5.md index 8d20f7fec..78b988a3c 100644 --- a/doc/dox/config/pipewire-client.conf.5.md +++ b/doc/dox/config/pipewire-client.conf.5.md @@ -104,7 +104,7 @@ Some of the properties refer to different aspects of the stream: A list of object properties that can be applied to streams can be found in \ref props__common_node_properties "pipewire-props(7) Common Node Properties" and -\ref props__audio_converter_properties "pipewire-props(7) Audio Adapter Properties" +\ref props__audio_adapter_properties "pipewire-props(7) Audio Adapter Properties" # STREAM RULES @IDX@ client.conf stream.rules diff --git a/doc/dox/config/pipewire-jack.conf.5.md b/doc/dox/config/pipewire-jack.conf.5.md index 8636aab21..91a1b2631 100644 --- a/doc/dox/config/pipewire-jack.conf.5.md +++ b/doc/dox/config/pipewire-jack.conf.5.md @@ -326,9 +326,9 @@ You can use this to link filters to devices. When there is no client connected t @PAR@ jack-env PIPEWIRE_NODE \parblock ``` -PIPEWIRE_NODE= +PIPEWIRE_NODE=\ \ ``` -Will sort the ports so that only the ports of the node with are listed. You can use this to force an application to only deal with the ports of a certain node, for example when auto connecting. +Will sort the ports so that only the ports of the node with \ are listed. You can use this to force an application to only deal with the ports of a certain node, for example when auto connecting. \endparblock # AUTHORS diff --git a/doc/dox/config/pipewire-props.7.md b/doc/dox/config/pipewire-props.7.md index e26805973..2883142a4 100644 --- a/doc/dox/config/pipewire-props.7.md +++ b/doc/dox/config/pipewire-props.7.md @@ -906,7 +906,7 @@ See \ref spa_param_port_config for the meaning. ## Monitor properties @PAR@ monitor-prop alsa.use-acp = true # boolean -Use \ref monitor-prop__alsa_card_profiles "ALSA Card Profiles" (ACP) for device configuration. +Use \ref props__alsa_card_profiles "ALSA Card Profiles" (ACP) for device configuration. This autodetects available ALSA devices and configures port and hardware mixers. @PAR@ monitor-prop alsa.use-ucm # boolean diff --git a/doc/dox/config/pipewire.conf.5.md b/doc/dox/config/pipewire.conf.5.md index 5ba06b093..3ffa1f8d5 100644 --- a/doc/dox/config/pipewire.conf.5.md +++ b/doc/dox/config/pipewire.conf.5.md @@ -4,7 +4,7 @@ The PipeWire server configuration file \tableofcontents -# SYNOPSIS +# SYNOPSIS {#synopsis} *$PIPEWIRE_CONFIG_DIR/pipewire/pipewire.conf* diff --git a/doc/dox/internals/access.dox b/doc/dox/internals/access.dox index fd4566362..7e3bdd445 100644 --- a/doc/dox/internals/access.dox +++ b/doc/dox/internals/access.dox @@ -118,7 +118,4 @@ full access. Manager applications (ie. applications that need to modify the graph) will set the \ref PW_KEY_MEDIA_CATEGORY property in the client object to "Manager". -For details on the pipewire-media-session implementation of access control, -see \ref page_media_session. - */ diff --git a/doc/dox/internals/dma-buf.dox b/doc/dox/internals/dma-buf.dox index 405f47e1c..604247bf2 100644 --- a/doc/dox/internals/dma-buf.dox +++ b/doc/dox/internals/dma-buf.dox @@ -79,10 +79,10 @@ modifier-aware one, or supporting both. On the `param_changed` event check if the modifier key is present and has the flag \ref SPA_POD_PROP_FLAG_DONT_FIXATE attached to it. In this case, extract all modifiers from the list and do a test allocation with your allocator to choose the preferred - modifier. Fixate on that \ref EnumFormat by announcing a \ref SPA_PARAM_EnumFormat with + modifier. Fixate on that \ref SPA_PARAM_EnumFormat by announcing a \ref SPA_PARAM_EnumFormat with only one modifier in the \ref SPA_CHOICE_Enum and without the \ref SPA_POD_PROP_FLAG_DONT_FIXATE flag, followed by the previous announced - \ref EnumFormat. This will retrigger the `param_changed` event with an + \ref SPA_PARAM_EnumFormat. This will retrigger the `param_changed` event with an \ref SPA_PARAM_Format as described below. If the \ref SPA_PARAM_Format contains a modifier key, without the flag \ref SPA_POD_PROP_FLAG_DONT_FIXATE, it should only contain one value in the @@ -263,7 +263,7 @@ on the buffer: When the metadata is available, the SyncObj fds are in the last 2 data planes of the buffer, the acquire and release syncobj respectively. You can keep a ref to the -\ref struct spa_meta_sync_timeline because we will need this later when processing +struct \ref spa_meta_sync_timeline because we will need this later when processing the buffers. If the producer is allocating buffers, when the stream has the \ref PW_STREAM_FLAG_ALLOC_BUFFERS @@ -281,11 +281,11 @@ for example, to make things easier later: ## Use the SPA_META_SyncTimeline when processing buffers -The \ref struct spa_meta_sync_timeline contains 2 fields: the acquire_point and +The struct \ref spa_meta_sync_timeline contains 2 fields: the acquire_point and release_point. Producers will start a render operation on the DMABUF of the buffer and place -the acquire_point in the \ref struct spa_meta_sync_timeline. When the rendering is +the acquire_point in the struct \ref spa_meta_sync_timeline. When the rendering is complete, the producer should signal the acquire_point on the acquire SyncObjTimeline. Producers will also add a release_point on the release SyncObjTimeline. They are diff --git a/doc/dox/programs/pipewire-pulse.1.md b/doc/dox/programs/pipewire-pulse.1.md index 66d2ec887..1dab9b4c1 100644 --- a/doc/dox/programs/pipewire-pulse.1.md +++ b/doc/dox/programs/pipewire-pulse.1.md @@ -30,7 +30,7 @@ Load the given config file (Default: pipewire-pulse.conf). # ENVIRONMENT VARIABLES -The generic \ref pipewire-env "pipewire(1) environment variables" +The generic \ref pipewire-env__environment_variables "pipewire(1) environment variables" are supported. In addition: diff --git a/doc/dox/programs/pipewire.1.md b/doc/dox/programs/pipewire.1.md index 43f03e3f1..56af4d64f 100644 --- a/doc/dox/programs/pipewire.1.md +++ b/doc/dox/programs/pipewire.1.md @@ -167,10 +167,10 @@ Enables the use of systemd for the logger, default true. ## Other settings @PAR@ pipewire-env PIPEWIRE_CPU -Selects the CPU and flags. This is a bitmask of any of the \ref CPU flags +Selects the CPU and flags. This is a bitmask of any of the \ref spa_cpu "CPU" flags @PAR@ pipewire-env PIPEWIRE_VM -Selects the Virtual Machine PipeWire is running on. This can be any of the \ref CPU "VM" +Selects the Virtual Machine PipeWire is running on. This can be any of the \ref spa_cpu "VM" types. @PAR@ pipewire-env DISABLE_RTKIT diff --git a/src/modules/meson.build b/src/modules/meson.build index 985e7c223..5c9052389 100644 --- a/src/modules/meson.build +++ b/src/modules/meson.build @@ -45,6 +45,8 @@ module_sources = [ 'module-snapcast-discover.c', 'module-vban-recv.c', 'module-vban-send.c', + 'module-sendspin-recv.c', + 'module-sendspin-send.c', 'module-session-manager.c', 'module-scheduler-v1.c', 'module-zeroconf-discover.c',