mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
modules: strip "PipeWire Module:" from Doxygen page name
Make them appear nicer in the output.
This commit is contained in:
parent
7f5f88c04a
commit
eca773fc12
41 changed files with 41 additions and 41 deletions
|
|
@ -29,7 +29,7 @@
|
|||
|
||||
#include "flatpak-utils.h"
|
||||
|
||||
/** \page page_module_access PipeWire Module: Access
|
||||
/** \page page_module_access Access
|
||||
*
|
||||
*
|
||||
* The `access` module performs access checks on clients. The access check
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
#include "modules/spa/spa-node.h"
|
||||
#include "module-adapter/adapter.h"
|
||||
|
||||
/** \page page_module_adapter PipeWire Module: Adapter
|
||||
/** \page page_module_adapter Adapter
|
||||
*/
|
||||
#define NAME "adapter"
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@
|
|||
|
||||
#include "module-avb/avb.h"
|
||||
|
||||
/** \page page_module_avb PipeWire Module: AVB
|
||||
/** \page page_module_avb AVB
|
||||
*/
|
||||
|
||||
#define NAME "avb"
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
|
||||
#include "module-client-device/client-device.h"
|
||||
|
||||
/** \page page_module_client_device PipeWire Module: Client Device
|
||||
/** \page page_module_client_device Client Device
|
||||
*/
|
||||
|
||||
#define NAME "client-device"
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
#include "module-client-node/v0/client-node.h"
|
||||
#include "module-client-node/client-node.h"
|
||||
|
||||
/** \page page_module_client_node PipeWire Module: Client Node
|
||||
/** \page page_module_client_node Client Node
|
||||
*/
|
||||
|
||||
#define NAME "client-node"
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/i18n.h>
|
||||
|
||||
/** \page page_module_combine_stream PipeWire Module: Combine Stream
|
||||
/** \page page_module_combine_stream Combine Stream
|
||||
*
|
||||
* The combine stream can make:
|
||||
*
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
|
||||
#include <pipewire/extensions/profiler.h>
|
||||
|
||||
/** \page page_module_echo_cancel PipeWire Module: Echo Cancel
|
||||
/** \page page_module_echo_cancel Echo Cancel
|
||||
*
|
||||
* The `echo-cancel` module performs echo cancellation. The module creates
|
||||
* virtual `echo-cancel-capture` source and `echo-cancel-playback` sink
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/extensions/profiler.h>
|
||||
|
||||
/** \page page_module_example_filter PipeWire Module: Example Filter
|
||||
/** \page page_module_example_filter Example Filter
|
||||
*
|
||||
* The example filter is a good starting point for writing a custom
|
||||
* filter. We refer to the source code for more information.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/i18n.h>
|
||||
|
||||
/** \page page_module_example_sink PipeWire Module: Example Sink
|
||||
/** \page page_module_example_sink Example Sink
|
||||
*
|
||||
* The example sink is a good starting point for writing a custom
|
||||
* sink. We refer to the source code for more information.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/i18n.h>
|
||||
|
||||
/** \page page_module_example_source PipeWire Module: Example Source
|
||||
/** \page page_module_example_source Example Source
|
||||
*
|
||||
* The example source is a good starting point for writing a custom
|
||||
* source. We refer to the source code for more information.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/i18n.h>
|
||||
|
||||
/** \page page_module_fallback_sink PipeWire Module: Fallback Sink
|
||||
/** \page page_module_fallback_sink Fallback Sink
|
||||
*
|
||||
* Fallback sink, which appear dynamically when no other sinks are
|
||||
* present. This is only useful for Pulseaudio compatibility.
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@
|
|||
|
||||
#include <libffado/ffado.h>
|
||||
|
||||
/** \page page_module_ffado_driver PipeWire Module: FFADO firewire audio driver
|
||||
/** \page page_module_ffado_driver FFADO firewire audio driver
|
||||
*
|
||||
* The ffado-driver module provides a source or sink using the libffado library for
|
||||
* reading and writing to firewire audio devices.
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
|||
#define PW_LOG_TOPIC_DEFAULT mod_topic
|
||||
|
||||
/**
|
||||
* \page page_module_filter_chain PipeWire Module: Filter-Chain
|
||||
* \page page_module_filter_chain Filter-Chain
|
||||
*
|
||||
* The filter-chain allows you to create an arbitrary processing graph
|
||||
* from LADSPA, LV2 and builtin filters. This filter can be made into a
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
#include "module-jack-tunnel/weakjack.h"
|
||||
|
||||
/** \page page_module_jack_tunnel PipeWire Module: JACK Tunnel
|
||||
/** \page page_module_jack_tunnel JACK Tunnel
|
||||
*
|
||||
* The jack-tunnel module provides a source or sink that tunnels all audio to
|
||||
* a JACK server.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
#include "pipewire/module.h"
|
||||
#include "pipewire/utils.h"
|
||||
|
||||
/** \page page_module_jackdbus_detect PipeWire Module: JACK DBus detect
|
||||
/** \page page_module_jackdbus_detect JACK DBus detect
|
||||
*
|
||||
* Automaticall creates a sink/source when a jackdbus server is started
|
||||
* and connect to JACK.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
|
||||
#include <pipewire/impl.h>
|
||||
|
||||
/** \page page_module_link_factory PipeWire Module: Link Factory
|
||||
/** \page page_module_link_factory Link Factory
|
||||
*/
|
||||
|
||||
#define NAME "link-factory"
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/extensions/profiler.h>
|
||||
|
||||
/** \page page_module_loopback PipeWire Module: Loopback
|
||||
/** \page page_module_loopback Loopback
|
||||
*
|
||||
* The loopback module passes the output of a capture stream unmodified to a playback stream.
|
||||
* It can be used to construct a link between a source and sink but also to
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/extensions/metadata.h>
|
||||
|
||||
/** \page page_module_metadata PipeWire Module: Metadata
|
||||
/** \page page_module_metadata Metadata
|
||||
*/
|
||||
|
||||
#define NAME "metadata"
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
#define IPTOS_DSCP(x) ((x) & IPTOS_DSCP_MASK)
|
||||
#endif
|
||||
|
||||
/** \page page_module_netjack2_driver PipeWire Module: Netjack2 driver
|
||||
/** \page page_module_netjack2_driver Netjack2 driver
|
||||
*
|
||||
* The netjack2-driver module provides a source or sink that is following a
|
||||
* netjack2 driver.
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@
|
|||
#define IPTOS_DSCP(x) ((x) & IPTOS_DSCP_MASK)
|
||||
#endif
|
||||
|
||||
/** \page page_module_netjack2_manager PipeWire Module: Netjack2 manager
|
||||
/** \page page_module_netjack2_manager Netjack2 manager
|
||||
*
|
||||
* The netjack2 manager module listens for new netjack2 driver messages and will
|
||||
* start a communication channel with them.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/i18n.h>
|
||||
|
||||
/** \page page_module_pipe_tunnel PipeWire Module: Unix Pipe Tunnel
|
||||
/** \page page_module_pipe_tunnel Unix Pipe Tunnel
|
||||
*
|
||||
* The pipe-tunnel module provides a source or sink that tunnels all audio to
|
||||
* or from a unix pipe respectively.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
#include "pipewire/module.h"
|
||||
#include "pipewire/utils.h"
|
||||
|
||||
/** \page page_module_portal PipeWire Module: Portal
|
||||
/** \page page_module_portal Portal
|
||||
*
|
||||
* The `portal` module performs access control management for clients started
|
||||
* inside an XDG portal.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
#include <pipewire/impl.h>
|
||||
#include <pipewire/extensions/profiler.h>
|
||||
|
||||
/** \page page_module_profiler PipeWire Module: Profiler
|
||||
/** \page page_module_profiler Profiler
|
||||
*
|
||||
* The profiler module provides a Profiler interface for applications that
|
||||
* can be used to receive profiling information.
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ PW_LOG_TOPIC(mod_topic_connection, "conn." NAME);
|
|||
#include <spa/debug/pod.h>
|
||||
#include <spa/debug/types.h>
|
||||
|
||||
/** \page page_module_protocol_native PipeWire Module: Protocol Native
|
||||
/** \page page_module_protocol_native Protocol Native
|
||||
*
|
||||
* The native protocol module implements the PipeWire communication between
|
||||
* a client and a server using unix local sockets.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
|
||||
#include "module-protocol-pulse/pulse-server.h"
|
||||
|
||||
/** \page page_module_protocol_pulse PipeWire Module: Protocol Pulse
|
||||
/** \page page_module_protocol_pulse Protocol Pulse
|
||||
*
|
||||
* This module implements a complete PulseAudio server on top of
|
||||
* PipeWire. This is only the server implementation, client are expected
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
|
||||
#include <pipewire/impl.h>
|
||||
|
||||
/** \page page_module_protocol_simple PipeWire Module: Protocol Simple
|
||||
/** \page page_module_protocol_simple Protocol Simple
|
||||
*
|
||||
* The simple protocol provides a bidirectional audio stream on a network
|
||||
* socket.
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
#include "module-protocol-pulse/defs.h"
|
||||
#include "module-protocol-pulse/format.h"
|
||||
|
||||
/** \page page_module_pulse_tunnel PipeWire Module: Pulse Tunnel
|
||||
/** \page page_module_pulse_tunnel Pulse Tunnel
|
||||
*
|
||||
* The pulse-tunnel module provides a source or sink that tunnels all audio to
|
||||
* a remote PulseAudio connection.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
#include "module-protocol-pulse/format.h"
|
||||
#include "module-zeroconf-discover/avahi-poll.h"
|
||||
|
||||
/** \page page_module_raop_discover PipeWire Module: RAOP Discover
|
||||
/** \page page_module_raop_discover RAOP Discover
|
||||
*
|
||||
* Automatically creates RAOP (Airplay) sink devices based on zeroconf
|
||||
* information.
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@
|
|||
#include "module-rtp/rtp.h"
|
||||
#include "module-rtp/stream.h"
|
||||
|
||||
/** \page page_module_raop_sink PipeWire Module: AirPlay Sink
|
||||
/** \page page_module_raop_sink AirPlay Sink
|
||||
*
|
||||
* Creates a new Sink to stream to an Airplay device.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@
|
|||
|
||||
#include "module-roc/common.h"
|
||||
|
||||
/** \page page_module_roc_sink PipeWire Module: ROC sink
|
||||
/** \page page_module_roc_sink ROC sink
|
||||
*
|
||||
* The `roc-sink` module creates a PipeWire sink that sends samples to
|
||||
* a preconfigured receiver address. One can then connect an audio stream
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@
|
|||
|
||||
#include "module-roc/common.h"
|
||||
|
||||
/** \page page_module_roc_source PipeWire Module: ROC source
|
||||
/** \page page_module_roc_source ROC source
|
||||
*
|
||||
* The `roc-source` module creates a PipeWire source that receives samples
|
||||
* from ROC sender and passes them to the sink it is connected to. One can
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@
|
|||
#include <dbus/dbus.h>
|
||||
#endif
|
||||
|
||||
/** \page page_module_rt PipeWire Module: RT
|
||||
/** \page page_module_rt RT
|
||||
*
|
||||
* The `rt` modules can give real-time priorities to processing threads.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
#define ifr_ifindex ifr_index
|
||||
#endif
|
||||
|
||||
/** \page page_module_rtp_sap PipeWire Module: SAP Announce and create RTP streams
|
||||
/** \page page_module_rtp_sap SAP Announce and create RTP streams
|
||||
*
|
||||
* The `rtp-sap` module announces RTP streams that match the rules with the
|
||||
* announce-stream action.
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@
|
|||
#define ifr_ifindex ifr_index
|
||||
#endif
|
||||
|
||||
/** \page page_module_rtp_session PipeWire Module: RTP session
|
||||
/** \page page_module_rtp_session RTP session
|
||||
*
|
||||
* The `rtp-session` module creates a media session that is announced
|
||||
* with avahi/mDNS/Bonjour.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
#define IPTOS_DSCP(x) ((x) & IPTOS_DSCP_MASK)
|
||||
#endif
|
||||
|
||||
/** \page page_module_rtp_sink PipeWire Module: RTP sink
|
||||
/** \page page_module_rtp_sink RTP sink
|
||||
*
|
||||
* The `rtp-sink` module creates a PipeWire sink that sends audio
|
||||
* RTP packets.
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
#define ifr_ifindex ifr_index
|
||||
#endif
|
||||
|
||||
/** \page page_module_rtp_source PipeWire Module: RTP source
|
||||
/** \page page_module_rtp_source RTP source
|
||||
*
|
||||
* The `rtp-source` module creates a PipeWire source that receives audio
|
||||
* and midi RTP packets.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
#include <pipewire/impl.h>
|
||||
|
||||
/** \page page_module_session_manager PipeWire Module: Session Manager
|
||||
/** \page page_module_session_manager Session Manager
|
||||
*
|
||||
* This module implements some usefull objects for implementing a session
|
||||
* manager. It is not yet actively used.
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
#define ifr_ifindex ifr_index
|
||||
#endif
|
||||
|
||||
/** \page page_module_vban_recv PipeWire Module: VBAN receiver
|
||||
/** \page page_module_vban_recv VBAN receiver
|
||||
*
|
||||
* The `vban-recv` module creates a PipeWire source that receives audio
|
||||
* and midi [VBAN](https://vb-audio.com) packets.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
#define IPTOS_DSCP(x) ((x) & IPTOS_DSCP_MASK)
|
||||
#endif
|
||||
|
||||
/** \page page_module_vban_send PipeWire Module: VBAN sender
|
||||
/** \page page_module_vban_send VBAN sender
|
||||
*
|
||||
* The `vban-send` module creates a PipeWire sink that sends
|
||||
* audio and midi [VBAN](https://vb-audio.com) packets.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
#include <pipewire/pipewire.h>
|
||||
#include <pipewire/impl.h>
|
||||
|
||||
/** \page page_module_x11_bell PipeWire Module: X11 Bell
|
||||
/** \page page_module_x11_bell X11 Bell
|
||||
*
|
||||
* The `x11-bell` module intercept the X11 bell events and uses libcanberra to
|
||||
* play a sound.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
#include "module-protocol-pulse/format.h"
|
||||
#include "module-zeroconf-discover/avahi-poll.h"
|
||||
|
||||
/** \page page_module_zeroconf_discover PipeWire Module: Zeroconf Discover
|
||||
/** \page page_module_zeroconf_discover Zeroconf Discover
|
||||
*
|
||||
* Use zeroconf to detect and load module-pulse-tunnel with the right
|
||||
* parameters. This will automatically create sinks and sources to stream
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue