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