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 <id> 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 <noreply@anthropic.com>
This commit is contained in:
Wim Taymans 2026-06-26 12:41:02 +02:00
parent c4b767cba1
commit f055949cb5
9 changed files with 15 additions and 16 deletions

View file

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

View file

@ -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=<id> <application>
PIPEWIRE_NODE=\<id\> \<application\>
```
Will sort the ports so that only the ports of the node with <id> 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 \<id\> 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

View file

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

View file

@ -4,7 +4,7 @@ The PipeWire server configuration file
\tableofcontents
# SYNOPSIS
# SYNOPSIS {#synopsis}
*$PIPEWIRE_CONFIG_DIR/pipewire/pipewire.conf*

View file

@ -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.
*/

View file

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

View file

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

View file

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

View file

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