mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/doc/meson.build

61 lines
1.6 KiB
Meson
Raw Normal View History

Add doxygen docs
2017-05-30 19:46:51 +02:00
doxyfile_conf = configuration_data()
doxyfile_conf.set('PACKAGE_NAME', meson.project_name())
doxyfile_conf.set('PACKAGE_VERSION', meson.project_version())
doxyfile_conf.set('top_srcdir', meson.source_root())
doxyfile_conf.set('top_builddir', meson.build_root())
if find_program('dot', required: false).found()
doxyfile_conf.set('HAVE_DOT', 'YES')
else
doxyfile_conf.set('HAVE_DOT', 'NO')
endif
dox: keep the doxygen input files as array in meson Keep all files as strings in an array so we can add them to the custom command input list - this way meson will correctly rebuild documentation on changes.
2021-05-07 08:53:51 +10:00
inputs = []
update docs
2017-09-05 13:35:25 +02:00
foreach h : pipewire_headers
dox: keep the doxygen input files as array in meson Keep all files as strings in an array so we can add them to the custom command input list - this way meson will correctly rebuild documentation on changes.
2021-05-07 08:53:51 +10:00
inputs += meson.source_root() / 'src' / 'pipewire' / h
update docs
2017-09-05 13:35:25 +02:00
endforeach
foreach h : pipewire_sources
dox: keep the doxygen input files as array in meson Keep all files as strings in an array so we can add them to the custom command input list - this way meson will correctly rebuild documentation on changes.
2021-05-07 08:53:51 +10:00
inputs += meson.source_root() / 'src' / 'pipewire' / h
update docs
2017-09-05 13:35:25 +02:00
endforeach
doc: add the various markdown prose docs to the doxygen output Note that the order of the includes matters - that's how doxygen will sort them. There is no specific structure other than the include order - one reason why the headers are being changed. Without polluting the markdown files with doxygen commands we cannot use \subpage, so all files convert to a regular \page and are listed as flat hierarchy in the sidebar (and in Related Pages). Changing the headers at least provides some visual grouping with comon prefixes.
2021-05-07 09:09:45 +10:00
extra_docs = [
'overview.md',
'design.txt',
'architecture.md',
'objects_design.md',
'tutorial-index.md',
'tutorial1.md',
'tutorial2.md',
'tutorial3.md',
'tutorial4.md',
'tutorial5.md',
'tutorial6.md',
'spa/index.md',
'spa/design.md',
'spa/pod.md',
'spa/buffer.md',
'pulseaudio.md',
]
foreach extra : extra_docs
inputs += meson.source_root() / 'doc' / extra
endforeach
dox: keep the doxygen input files as array in meson Keep all files as strings in an array so we can add them to the custom command input list - this way meson will correctly rebuild documentation on changes.
2021-05-07 08:53:51 +10:00
doxyfile_conf.set('inputs', ' '.join(inputs))
update docs
2017-09-05 13:35:25 +02:00
Add doxygen docs
2017-05-30 19:46:51 +02:00
doxyfile = configure_file(input: 'Doxyfile.in',
output: 'Doxyfile',
require meson 0.49
2020-05-19 16:49:38 +02:00
configuration: doxyfile_conf)
Add doxygen docs
2017-05-30 19:46:51 +02:00
doc: add docdir option As patched in Gentoo. Fixes #1057
2021-04-15 21:45:53 +03:00
docdir = get_option('docdir')
if docdir == ''
docdir = pipewire_datadir / 'doc' / meson.project_name()
endif
Add doxygen docs
2017-05-30 19:46:51 +02:00
html_target = custom_target('pipewire-docs',
dox: keep the doxygen input files as array in meson Keep all files as strings in an array so we can add them to the custom command input list - this way meson will correctly rebuild documentation on changes.
2021-05-07 08:53:51 +10:00
input: [ doxyfile ] + inputs,
Add doxygen docs
2017-05-30 19:46:51 +02:00
output: [ 'html' ],
command: [ doxygen, doxyfile ],
install: true,
doc: add docdir option As patched in Gentoo. Fixes #1057
2021-04-15 21:45:53 +03:00
install_dir: docdir)
Reference in a new issue Copy permalink