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

100 lines
3 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 spa to doxygen output This requires a helper script: doxygen doesn't differ between static methods and static inline methods. EXTRACT_STATIC defines whether it parses *any* static method but we're currently using all C files as input files as well. We cannot convince doxygen to just parse static inline functions in header files so for SPA we hack around this: meson passes the spa headers to a shell script with simply copies those changed to `/* static */ inline void (foo)` and doxygen then runs on those header files. The result: we get all spa functions added to your doxygen output at the cost of a few sed calls.
2021-05-21 13:53:19 +10:00
# SPA headers use static inline functions. Doxygen doesn't extract those
# unless we have EXTRACT_STATIC set - but we don't want it to extract
# everything in the rest of the tree.
# The shell script here basically does a:
# cp spa/* builddir/spa/ && sed -i 's/^static//' buildir/spa/**.h
# The copied files are passed to doxygen as input and they are parsed as
# normal functions.
# Because this uses globbing, this target won't rebuild if the headers
# change but meh.
spa_header_dirs = []
sed = find_program('sed', required: false)
if sed.found()
spa_srcdir = meson.source_root() / 'spa' / 'include' / 'spa'
spa_dstdir = meson.current_build_dir() / 'spa'
spa_strip_static = custom_target(
'spa-strip-static',
command: [ find_program('strip-static.sh'), spa_srcdir, spa_dstdir ],
build_by_default: true,
output: 'spa',
)
spa_header_dirs += spa_dstdir
else
spa_strip_static = []
endif
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 19:55:06 +10:00
# Note: order here is how doxygen will expose the pages in the sidebar
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 = [
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 19:55:06 +10:00
'index.dox',
'pipewire.dox',
'pipewire-overview.dox',
'pipewire-design.dox',
'pipewire-daemon.dox',
'pipewire-library.dox',
'pipewire-tools.dox',
'pipewire-session-manager.dox',
'pipewire-objects-design.dox',
'api.dox',
doc: change the tutorials to doxygen sources While doxygen can handle markdown pages, support for it is very limited: markdown pages can only be included as a whole page, they get an automatic title (custom titles are possible but aren't standard markdown) and it's not possible to use \subpage without messing with the markdown again. Any markdown page will thus end up as separate item in the doxygen output, not really suitable for generating a good page hiearchy. Let's switch the tutorial to use doxygen directly instead of markdown, short of using code/endcode instead of markdown's ``` there isn't that much difference anyway but it allows us to structure things nicer in the online docs.
2021-05-25 13:08:04 +10:00
'tutorial.dox',
'tutorial1.dox',
'tutorial2.dox',
'tutorial3.dox',
'tutorial4.dox',
'tutorial5.dox',
'tutorial6.dox',
doc: switch the spa documentation to doxygen
2021-05-25 13:37:47 +10:00
'spa-index.dox',
'spa-design.dox',
'spa-pod.dox',
'spa-buffer.dox',
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 19:55:06 +10:00
'pulseaudio.dox',
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
]
foreach extra : extra_docs
inputs += meson.source_root() / 'doc' / extra
endforeach
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
cssfiles = [
meson.source_root() / 'doc' / 'doxygen-awesome.css',
meson.source_root() / 'doc' / 'custom.css'
]
doc: add spa to doxygen output This requires a helper script: doxygen doesn't differ between static methods and static inline methods. EXTRACT_STATIC defines whether it parses *any* static method but we're currently using all C files as input files as well. We cannot convince doxygen to just parse static inline functions in header files so for SPA we hack around this: meson passes the spa headers to a shell script with simply copies those changed to `/* static */ inline void (foo)` and doxygen then runs on those header files. The result: we get all spa functions added to your doxygen output at the cost of a few sed calls.
2021-05-21 13:53:19 +10:00
doxyfile_conf.set('inputs', ' '.join(inputs + [spa_dstdir]))
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
doxyfile_conf.set('cssfiles', ' '.join(cssfiles))
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',
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
input: [ doxyfile ] + inputs + cssfiles,
Add doxygen docs
2017-05-30 19:46:51 +02:00
output: [ 'html' ],
command: [ doxygen, doxyfile ],
doc: add spa to doxygen output This requires a helper script: doxygen doesn't differ between static methods and static inline methods. EXTRACT_STATIC defines whether it parses *any* static method but we're currently using all C files as input files as well. We cannot convince doxygen to just parse static inline functions in header files so for SPA we hack around this: meson passes the spa headers to a shell script with simply copies those changed to `/* static */ inline void (foo)` and doxygen then runs on those header files. The result: we get all spa functions added to your doxygen output at the cost of a few sed calls.
2021-05-21 13:53:19 +10:00
depends: spa_strip_static,
Add doxygen docs
2017-05-30 19:46:51 +02:00
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