doc: add a media-session header file with the access-flatpak module

This adds a new top-level documentation entry for pipewire-media-session
with a list of modules (currently only one). Similar setup to the
pipewire modules, it allows us to document all modules in-place.
This commit is contained in:
Peter Hutterer 2021-07-29 15:44:37 +10:00
parent c03fedbac2
commit d1c80183d9
4 changed files with 25 additions and 1 deletions

15
doc/media-session.dox Normal file
View file

@ -0,0 +1,15 @@
/**
\page page_media_session Media Session
PipeWire Media Session is the reference/example session manager provided by
the PipeWire project.
# Modules
List of Media Session modules:
- \subpage page_media_session_module_access_flatpak
*/

View file

@ -22,6 +22,9 @@ endforeach
foreach h : module_sources
inputs += meson.source_root() / 'src' / 'modules' / h
endforeach
foreach h : media_session_sources
inputs += meson.source_root() / 'src' / 'examples' / h
endforeach
inputs += meson.source_root() / 'test' / 'pwtest.h'
# SPA headers use static inline functions. Doxygen doesn't extract those
@ -64,6 +67,7 @@ extra_docs = [
'pipewire-session-manager.dox',
'pipewire-objects-design.dox',
'pipewire-audio.dox',
'media-session.dox',
'api.dox',
'tutorial.dox',
'tutorial1.dox',

View file

@ -36,6 +36,8 @@
#include "media-session.h"
/** \page page_media_session_module_access_flatpak Media Session Module: Access Flatpak
*/
#define NAME "access-flatpak"
#define SESSION_KEY "access-flatpak"

View file

@ -63,7 +63,7 @@ if get_option('session-managers').contains('media-session') and alsa_dep.found()
sm_logind_src = ['media-session/logind.c']
sm_logind_dep = [systemd_dep]
endif
executable('pipewire-media-session',
media_session_sources = [
'media-session/access-flatpak.c',
'media-session/access-portal.c',
'media-session/alsa-midi.c',
@ -87,6 +87,9 @@ if get_option('session-managers').contains('media-session') and alsa_dep.found()
'media-session/v4l2-endpoint.c',
'media-session/libcamera-monitor.c',
'media-session/suspend-node.c',
]
executable('pipewire-media-session',
media_session_sources,
sm_logind_src,
install: true,
dependencies : [dbus_dep, pipewire_dep, alsa_dep, mathlib, sm_logind_dep, libinotify_dep],