modules: add Module Name section to the module reference docs

src/modules/module-access.c

@@ -63,6 +63,10 @@
  * `pipewire.access.portal.app_id` property is to the Flatpak application ID, if
  * found. In addition, `pipewire.sec.flatpak` is set to `true`.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-access`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-adapter.c

@@ -19,6 +19,10 @@
 #include "module-adapter/adapter.h"
 
 /** \page page_module_adapter Adapter
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-adapter`
  */
 #define NAME "adapter"
 

src/modules/module-avb.c

@@ -22,6 +22,10 @@
 #include "module-avb/avb.h"
 
 /** \page page_module_avb AVB
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-avb`
  */
 
 #define NAME "avb"

src/modules/module-client-device.c

@@ -16,6 +16,10 @@
 #include "module-client-device/client-device.h"
 
 /** \page page_module_client_device Client Device
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-client-device`
  */
 
 #define NAME "client-device"

src/modules/module-client-node.c

@@ -17,6 +17,10 @@
 #include "module-client-node/client-node.h"
 
 /** \page page_module_client_node Client Node
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-client-node`
  */
 
 #define NAME "client-node"

src/modules/module-combine-stream.c

@@ -40,6 +40,10 @@
  * rules. This makes it possible to combine static nodes or nodes based on certain
  * properties.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-combine-stream`
+ *
  * ## Module Options
  *
  * - `node.name`: a unique name for the stream

src/modules/module-echo-cancel.c

@@ -80,6 +80,10 @@
  *   This data then goes into the application (the conference application) and
  *   does not contain the echo from the other participants anymore.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-echo-cancel`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-example-filter.c

@@ -27,6 +27,10 @@
  * The example filter is a good starting point for writing a custom
  * filter. We refer to the source code for more information.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-example-filter`
+ *
  * ## Module Options
  *
  * - `node.description`: a human readable name for the filter streams

src/modules/module-example-sink.c

@@ -33,6 +33,10 @@
  * The example sink is a good starting point for writing a custom
  * sink. We refer to the source code for more information.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-example-sink`
+ *
  * ## Module Options
  *
  * - `node.name`: a unique name for the stream

src/modules/module-example-source.c

@@ -33,6 +33,10 @@
  * The example source is a good starting point for writing a custom
  * source. We refer to the source code for more information.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-example-source`
+ *
  * ## Module Options
  *
  * - `node.name`: a unique name for the stream

src/modules/module-fallback-sink.c

@@ -23,6 +23,15 @@
  *
  * Fallback sink, which appear dynamically when no other sinks are
  * present. This is only useful for Pulseaudio compatibility.
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-fallback-sink`
+ *
+ * ## Module Options
+ *
+ * - `sink.name`: sink name
+ * - `sink.description`: sink description
  */
 
 #define NAME "fallback-sink"

src/modules/module-ffado-driver.c

@@ -36,6 +36,10 @@
  * The ffado-driver module provides a source or sink using the libffado library for
  * reading and writing to firewire audio devices.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-ffado-driver`
+ *
  * ## Module Options
  *
  * - `driver.mode`: the driver mode, sink|source|duplex, default duplex

src/modules/module-filter-chain.c

@@ -48,6 +48,10 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
  * manager can manage the configuration and connection with the sinks and
  * sources automatically.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-filter-chain`
+ *
  * ## Module Options
  *
  * - `node.description`: a human readable name for the filter chain

src/modules/module-jack-tunnel.c

@@ -39,6 +39,10 @@
  * automatically load the tunnel with the right parameters based on dbus
  * information.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-jack-tunnel`
+ *
  * ## Module Options
  *
  * - `jack.library`: the libjack to load, by default libjack.so.0 is searched in

src/modules/module-jackdbus-detect.c

@@ -30,6 +30,10 @@
  * Automaticall creates a sink/source when a jackdbus server is started
  * and connect to JACK.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-jackdbus-detect`
+ *
  * ## Module Options
  *
  * There are no module-specific options, all arguments are passed to

src/modules/module-link-factory.c

@@ -15,6 +15,10 @@
 #include <pipewire/impl.h>
 
 /** \page page_module_link_factory Link Factory
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-link-factory`
  */
 
 #define NAME "link-factory"

src/modules/module-loopback.c

@@ -31,6 +31,10 @@
  * Because both ends of the loopback are built with streams, the session manager can
  * manage the configuration and connection with the sinks and sources.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-loopback`
+ *
  * ## Module Options
  *
  * - `node.description`: a human readable name for the loopback streams

src/modules/module-metadata.c

@@ -16,6 +16,10 @@
 #include <pipewire/extensions/metadata.h>
 
 /** \page page_module_metadata Metadata
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-metadata`
  */
 
 #define NAME "metadata"

src/modules/module-netjack2-driver.c

@@ -45,6 +45,10 @@
  * The netjack2-driver module provides a source or sink that is following a
  * netjack2 driver.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-netjack2-driver`
+ *
  * ## Module Options
  *
  * - `driver.mode`: the driver mode, sink|source|duplex, default duplex

src/modules/module-netjack2-manager.c

@@ -47,6 +47,10 @@
  * The netjack2 manager module listens for new netjack2 driver messages and will
  * start a communication channel with them.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-netjack2-manager`
+ *
  * ## Module Options
  *
  * - `local.ifname = <str>`: interface name to use

src/modules/module-pipe-tunnel.c

@@ -37,6 +37,10 @@
  * The pipe-tunnel module provides a source or sink that tunnels all audio to
  * or from a unix pipe respectively.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-pipe-tunnel`
+ *
  * ## Module Options
  *
  * - `tunnel.mode`: the desired tunnel to create. (Default `playback`)

src/modules/module-portal.c

@@ -42,6 +42,10 @@
  *
  * Clients connecting from other PIDs are ignored by this module.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-portal`
+ *
  * ## Module Options
  *
  * There are no module-specific options.

src/modules/module-profiler.c

@@ -30,6 +30,10 @@
  * Use tools like pw-top and pw-profiler to collect profiling information
  * about the pipewire graph.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-profiler`
+ *
  * ## Example configuration
  *
  * The module has no arguments and is usually added to the config file of

src/modules/module-protocol-native.c

@@ -71,6 +71,10 @@ PW_LOG_TOPIC(mod_topic_connection, "conn." NAME);
  * Normally this module is loaded in both client and server config files
  * so that they cam communicate.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-protocol-native`
+ *
  * ## Module Options
  *
  * The module supports the following arguments:

src/modules/module-protocol-pulse.c

@@ -33,6 +33,10 @@
  * The pulse server implements a sample cache that is otherwise not
  * available in PipeWire.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-protocol-pulse`
+ *
  * ## Module Options
  *
  * The module arguments can be the contents of the pulse.properties but
@@ -86,7 +90,7 @@
  *\endcode
  *
  * The addresses the server listens on when starting. Uncomment the `tcp:4713` entry to also
- * make the server listen on a tcp socket. This is equivalent to loading `module-native-protocol-tcp`.
+ * make the server listen on a tcp socket. This is equivalent to loading `libpipewire-module-native-protocol-tcp`.
  *
  * There is also a slightly more verbose syntax with more options:
  *

src/modules/module-protocol-simple.c

@@ -40,6 +40,10 @@
  * Each client that connects will create a capture and/or playback stream,
  * depending on the configuration options.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-protocol-simple`
+ *
  * ## Module Options
  *
  *  - `capture`: boolean if capture is enabled. This will create a capture stream

src/modules/module-pulse-tunnel.c

@@ -47,6 +47,10 @@
  * automatically load the tunnel with the right parameters based on zeroconf
  * information.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-pulse-tunnel`
+ *
  * ## Module Options
  *
  * - `tunnel.mode`: the desired tunnel to create, must be `source` or `sink`.

src/modules/module-raop-discover.c

@@ -37,6 +37,10 @@
  * If no stream.rules are given, it will create a sink for all announced
  * streams.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-raop-discover`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-raop-sink.c

@@ -55,6 +55,10 @@
  * with the right parameters but it is possible to manually create a RAOP sink
  * as well.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-raop-sink`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-roc-sink.c

@@ -30,6 +30,10 @@
  * a preconfigured receiver address. One can then connect an audio stream
  * of any running application to that sink or make it the default sink.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-roc-sink`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-roc-source.c

@@ -30,6 +30,10 @@
  * from ROC sender and passes them to the sink it is connected to. One can
  * then connect it to any audio device.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-roc-source`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-rt.c

@@ -69,6 +69,10 @@
  * up and DBus is available, then this module will fall back to using the Portal
  * Realtime DBus API or RTKit.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-rt`
+ *
  * ## Module Options
  *
  * - `nice.level`: The nice value set for the application thread. It improves

src/modules/module-rtp-sap.c

@@ -40,6 +40,10 @@
  * sess.sap.announce = true and it will create a receiver for all announced
  * streams.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-rtp-sap`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-rtp-session.c

@@ -52,6 +52,10 @@
  * The session setup is based on apple-midi and is compatible with
  * apple-midi when the session is using midi.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-rtp-session`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-rtp-sink.c

@@ -37,6 +37,10 @@
  * The `rtp-sink` module creates a PipeWire sink that sends audio
  * RTP packets.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-rtp-sink`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-rtp-source.c

@@ -43,6 +43,10 @@
  * This module is usually loaded from the \ref page_module_rtp_sap so that the
  * source.ip and source.port and format parameters matches that of the sender.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-rtp-source`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-session-manager.c

@@ -11,6 +11,10 @@
  *
  * This module implements some usefull objects for implementing a session
  * manager. It is not yet actively used.
+ *
+ * ## Module Name
+ *
+ * `libpipewire-module-session-manager`
  */
 
 /* client-endpoint.c */

src/modules/module-vban-recv.c

@@ -40,6 +40,10 @@
  * The `vban-recv` module creates a PipeWire source that receives audio
  * and midi [VBAN](https://vb-audio.com) packets.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-vban-recv`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-vban-send.c

@@ -37,6 +37,10 @@
  * The `vban-send` module creates a PipeWire sink that sends
  * audio and midi [VBAN](https://vb-audio.com) packets.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-vban-send`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module

src/modules/module-x11-bell.c

@@ -32,6 +32,10 @@
  * The `x11-bell` module intercept the X11 bell events and uses libcanberra to
  * play a sound.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-x11-bell`
+ *
  * ## Module Options
  *
  * - `sink.name = <str>`: node.name of the sink to connect to

src/modules/module-zeroconf-discover.c

@@ -34,6 +34,10 @@
  * audio to/from remote PulseAudio servers. It also works with
  * module-protocol-pulse.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-zeroconf-discover`
+ *
  * ## Module Options
  *
  * - `pulse.latency`: the latency to end-to-end latency in milliseconds to