improve module docs
This commit is contained in:
parent
b3bb7fd567
commit
c324a9fb42
|
@ -36,15 +36,15 @@
|
|||
* The jack-tunnel module provides a source or sink that tunnels all audio to
|
||||
* a JACK server.
|
||||
*
|
||||
* This module is usually used together with module-jack-dbus that will
|
||||
* This module is usually used together with \ref page_module_jackdbus_detect that will
|
||||
* automatically load the tunnel with the right parameters based on dbus
|
||||
* information.
|
||||
*
|
||||
* ## Module Options
|
||||
*
|
||||
* - `jack.library`: the libjack to load, by default libjack.so.0 is searched in
|
||||
* JACK_PATH directories and then some standard library paths.
|
||||
* Can be an absolute path.
|
||||
* JACK_PATH directories and then some standard library paths.
|
||||
* Can be an absolute path.
|
||||
* - `jack.server`: the name of the JACK server to tunnel to.
|
||||
* - `jack.client-name`: the name of the JACK client.
|
||||
* - `jack.connect`: if jack ports should be connected automatically can also be
|
||||
|
@ -102,6 +102,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
|||
#define DEFAULT_POSITION "[ FL FR ]"
|
||||
|
||||
#define MODULE_USAGE "( remote.name=<remote> ] " \
|
||||
"( jack.library=<jack library path> ) " \
|
||||
"( jack.server=<server name> ) " \
|
||||
"( jack.client-name=<name of the JACK client> ] " \
|
||||
"( jack.connect=<bool, autoconnect ports> ] " \
|
||||
|
|
|
@ -33,11 +33,7 @@
|
|||
* ## Module Options
|
||||
*
|
||||
* There are no module-specific options, all arguments are passed to
|
||||
* \page page_module_jack_tunnel.
|
||||
*
|
||||
* ## General options
|
||||
*
|
||||
* There are no general options for this module.
|
||||
* \ref page_module_jack_tunnel.
|
||||
*
|
||||
* ## Example configuration
|
||||
*\code{.unparsed}
|
||||
|
|
Loading…
Reference in New Issue