mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
docs: add more docs for the SPA modules
This commit is contained in:
parent
73e7f61d8c
commit
f60fe6d6e4
5 changed files with 25 additions and 0 deletions
|
|
@ -146,6 +146,9 @@ endforeach
|
|||
foreach h : module_sources
|
||||
inputs += meson.project_source_root() / 'src' / 'modules' / h
|
||||
endforeach
|
||||
foreach h : module_spa_sources
|
||||
inputs += meson.project_source_root() / 'src' / 'modules' / 'spa' / h
|
||||
endforeach
|
||||
foreach h : pipewire_module_protocol_pulse_sources
|
||||
inputs += meson.project_source_root() / 'src' / 'modules' / h
|
||||
endforeach
|
||||
|
|
@ -210,6 +213,12 @@ foreach m : module_sources
|
|||
module_manpage_list += f'\\ref page_@pagepart@ "libpipewire-@name@(7)"'
|
||||
manpages += [[f'libpipewire-@name@.7', f'page_@pagepart@']]
|
||||
endforeach
|
||||
foreach m : module_spa_sources
|
||||
name = fs.stem(m)
|
||||
pagepart = name.replace('-', '_')
|
||||
module_manpage_list += f'\\ref page_@pagepart@ "libpipewire-@name@(7)"'
|
||||
manpages += [[f'libpipewire-@name@.7', f'page_@pagepart@']]
|
||||
endforeach
|
||||
|
||||
doxygen_env.set('LIBPIPEWIRE_MODULES', '<ul><li>' + '</li><li>'.join(module_manpage_list) + '</li></ul>')
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@
|
|||
|
||||
#include "spa-device.h"
|
||||
|
||||
/** \page page_module_spa_device_factory SPA Device factory
|
||||
*
|
||||
* Provide a factory to create SPA devices.
|
||||
*/
|
||||
#define NAME "spa-device-factory"
|
||||
|
||||
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
||||
|
|
|
|||
|
|
@ -12,6 +12,10 @@
|
|||
|
||||
#include "spa-device.h"
|
||||
|
||||
/** \page page_module_spa_device SPA Device
|
||||
*
|
||||
* Load and manage an SPA device.
|
||||
*/
|
||||
#define NAME "spa-device"
|
||||
|
||||
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@
|
|||
|
||||
#include "spa-node.h"
|
||||
|
||||
/** \page page_module_spa_node_factory SPA Node factory
|
||||
*
|
||||
* Provide a factory to create SPA nodes.
|
||||
*/
|
||||
#define NAME "spa-node-factory"
|
||||
|
||||
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@
|
|||
|
||||
#include "spa-node.h"
|
||||
|
||||
/** \page page_module_spa_node SPA Node
|
||||
*
|
||||
* Load and manage an SPA node.
|
||||
*/
|
||||
#define NAME "spa-node"
|
||||
|
||||
PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue