docs: escape angle brackets and fix @filename and \ref in doc comments

Escape <portname>, <tensorname>, <paramname>, <port>, <rules> and
similar angle-bracket placeholders that doxygen interprets as HTML
tags. Also escape @filename (unknown doxygen command) and fix the
pw_stream::process() reference in thread-loop.h.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Wim Taymans 2026-06-26 12:43:56 +02:00
parent f055949cb5
commit 9710f02837
9 changed files with 15 additions and 15 deletions

View file

@ -31,7 +31,7 @@ as the input format.
Number of samples per iteration (default 4096)
\par -P PROPERTIES | \--properties=PROPERTIES
Set extra stream properties as a JSON object. One can also use @filename to
Set extra stream properties as a JSON object. One can also use \@filename to
read the JSON object with properties from filename.
\par -c CHANNELS | \--channels=CHANNELS

View file

@ -1009,16 +1009,16 @@ extern struct spa_handle_factory spa_filter_graph_factory;
* therefore at least be blocksize + retain samples large.
* - `data` where the data for the tensor is comming from. There are different options
* based on the value of this file, selected with a prefix:
* - `port:<portname>` a new input/output port is created on the plugin with the
* name <portname> and the data for the tensor will be obtained
* - `port:\<portname\>` a new input/output port is created on the plugin with the
* name \<portname\> and the data for the tensor will be obtained
* or copied from/to the port data.
* - `tensor:<tensorname>` the data of this tensor is copied from the given
* <tensorname>. You can use this to copy output state
* - `tensor:\<tensorname\>` the data of this tensor is copied from the given
* \<tensorname\>. You can use this to copy output state
* info to the input state, for example.
* - `param:<paramname>` the data of this tensor is obtained from a parameter with
* <paramname>. Currently only `rate` is a valid paramname,
* - `param:\<paramname\>` the data of this tensor is obtained from a parameter with
* \<paramname\>. Currently only `rate` is a valid paramname,
* which has the value of the filter samplerate.
* - `control:<portname>` a new input/output control port is created and the tensor
* - `control:\<portname\>` a new input/output control port is created and the tensor
* data will be obtained/copied from/to the control data.
*
* Here is an example of the silero VAD model:

View file

@ -61,7 +61,7 @@
* - `local.ifname = <str>`: interface name to use
* - `local.ifaddress = <str>`: interface address to use
* - `server.address = []`: an array of server addresses to listen on as
* tcp:(<ip>:)<port>.
* tcp:(\<ip\>:)\<port\>.
* - `capture.props`: optional properties for the capture stream
* - `playback.props`: optional properties for the playback stream
*

View file

@ -46,7 +46,7 @@
* false by default.
* - `raop.latency.ms` = latency for all streams in microseconds. This
* can be overwritten in the stream rules.
* - `stream.rules` = <rules>: match rules, use create-stream actions. See
* - `stream.rules` = \<rules\>: match rules, use create-stream actions. See
* \ref page_module_raop_sink for module properties.
*
* ## Example configuration

View file

@ -59,7 +59,7 @@
* - `source.ip =<str>`: source IP address, default "0.0.0.0"
* - `net.ttl = <int>`: TTL to use, default 1
* - `net.loop = <bool>`: loopback multicast, default false
* - `stream.rules` = <rules>: match rules, use create-stream and announce-stream actions
* - `stream.rules` = \<rules\>: match rules, use create-stream and announce-stream actions
* - `sap.max-sessions = <int>`: maximum number of concurrent send/receive sessions to track
* - `sap.preamble-extra = [strings]`: extra attributes to add to the atomic SDP preamble
* - `sap.end-extra = [strings]`: extra attributes to add to the end of the SDP message

View file

@ -72,7 +72,7 @@
* - `sendspin.delay`: the delay to add to clients in seconds. Default 5.0
* - `node.always-process = <bool>`: true to send silence even when not connected.
* - `stream.props = {}`: properties to be passed to all the stream
* - `stream.rules` = <rules>: match rules, use the create-stream action to
* - `stream.rules` = \<rules\>: match rules, use the create-stream action to
* make a stream for the client.
*
* ## General options

View file

@ -60,7 +60,7 @@
*
* - `snapcast.discover-local` = allow discovery of local services as well.
* false by default.
* - `stream.rules` = <rules>: match rules, use create-stream actions. See
* - `stream.rules` = \<rules\>: match rules, use create-stream actions. See
* \ref page_module_protocol_simple for module properties.
*
* ### stream.rules matches

View file

@ -55,7 +55,7 @@
* - `node.always-process = <bool>`: true to receive even when not running
* - `sess.latency.msec = <str>`: target network latency in milliseconds, default 100
* - `stream.props = {}`: properties to be passed to all the stream
* - `stream.rules` = <rules>: match rules, use create-stream actions.
* - `stream.rules` = \<rules\>: match rules, use create-stream actions.
*
* ### stream.rules matches
*

View file

@ -63,7 +63,7 @@ extern "C" {
*
* An exception to this is for the data processing callbacks, which are
* explcitly marked as being emitted from the data realtime threads. One
* such callback is the \ref pw_stream::process() callback when the
* such callback is the `process()` callback of \ref pw_stream when the
* \ref PW_STREAM_FLAG_RT_PROCESS is set.
*
*/