mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2026-01-02 11:08:48 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: link examples to Doxygen docs

Browse source 
Include examples to the documentation, using Doxygen's example system.
This commit is contained in:
Pauli Virtanen 2021-10-09 23:25:29 +03:00
parent f6d69f9bcd
commit 98a0e54d5f
25 changed files with 192 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

45
doc/meson.build
View file

@ -84,6 +84,49 @@ cssfiles = [
meson.source_root() / 'doc' / 'custom.css'
]
# Example files (in order from simple to esoteric)
example_files = [
'audio-src.c',
'audio-dsp-src.c',
'audio-dsp-filter.c',
'video-play.c',
'video-src.c',
'video-dsp-play.c',
'video-play-pull.c',
'video-play-reneg.c',
'video-src-alloc.c',
'video-src-reneg.c',
'export-sink.c',
'export-source.c',
'export-spa.c',
'export-spa-device.c',
'bluez-session.c',
'local-v4l2.c',
'spa/examples/adapter-control.c',
'spa/examples/example-control.c',
'spa/examples/local-libcamera.c',
'spa/examples/local-v4l2.c',
]
example_doxygen = []
example_ref = []
foreach h : example_files
example_doxygen += ['\\example ' + h,
'\\snippet{doc} ' + h + ' title',
'<br>',
'\\snippet{doc} ' + h + ' doc']
example_ref += ['- \\ref ' + h + ' "": \snippet{doc} ' + h + ' title']
endforeach
examples_dox_conf = configuration_data()
examples_dox_conf.set('example_doxygen', '\n'.join(example_doxygen))
examples_dox_conf.set('example_ref', '\n'.join(example_ref))
examples_dox = configure_file(input: 'examples.dox.in',
output: 'examples.dox',
configuration: examples_dox_conf)
input_dirs += [ 'doc/examples.dox' ]
doxyfile_conf.set('inputs', ' '.join(inputs + input_dirs))
doxyfile_conf.set('cssfiles', ' '.join(cssfiles))
doxyfile_conf.set('path_prefixes', ' '.join(path_prefixes))
@ -100,7 +143,7 @@ if docdir == ''
endif
html_target = custom_target('pipewire-docs',
input: [ doxyfile ] + inputs + cssfiles,
input: [ doxyfile, examples_dox ] + inputs + cssfiles,
output: [ 'html' ],
command: [ doxygen, doxyfile ],
install: true,