docs: improve docs a little

This commit is contained in:
Wim Taymans 2022-06-23 18:55:02 +02:00
parent df457e99b2
commit 532fc29c85
2 changed files with 15 additions and 4 deletions

View file

@ -214,14 +214,16 @@
* VMs usually can't support the low latency settings that are possible on real * VMs usually can't support the low latency settings that are possible on real
* hardware. * hardware.
* *
* ## Application settings (Rules) * ## Stream settings and rules
*
* The pulse protocol module supports generic config rules. It provides a `quirks`
* and an `update-props` action.
* *
* Streams created by module-protocol-pulse will use the stream.properties * Streams created by module-protocol-pulse will use the stream.properties
* section and stream.rules sections as usual. * section and stream.rules sections as usual.
* *
* ## Application settings (Rules)
*
* The pulse protocol module supports generic config rules. It supports a pulse.rules
* section with a `quirks` and an `update-props` action.
*
*\code{.unparsed} *\code{.unparsed}
* pulse.rules = [ * pulse.rules = [
* { * {

View file

@ -161,6 +161,15 @@ extern "C" {
* \section sec_stream_disconnect Disconnect * \section sec_stream_disconnect Disconnect
* *
* Use \ref pw_stream_disconnect() to disconnect a stream after use. * Use \ref pw_stream_disconnect() to disconnect a stream after use.
*
* \section sec_stream_configuration Configuration
*
* \subsection ssec_config_properties Stream Properties
*
* \subsection ssec_config_rules Stream Rules
*
* \section sec_stream_environment Environment Variables
*
*/ */
/** \defgroup pw_stream Stream /** \defgroup pw_stream Stream
* *