mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-12-15 08:56:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: change the tutorials to doxygen sources

Browse source 
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.
This commit is contained in:
Peter Hutterer 2021-05-25 13:08:04 +10:00 • committed by Wim Taymans
parent fce28ac59b
commit 9ed9980fa2
9 changed files with 145 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/meson.build
View file

@ -48,13 +48,13 @@ extra_docs = [
'pipewire-design.md',
'pipewire-architecture.md',
'pipewire-objects-design.md',
'tutorial-index.md',
'tutorial1.md',
'tutorial2.md',
'tutorial3.md',
'tutorial4.md',
'tutorial5.md',
'tutorial6.md',
'tutorial.dox',
'tutorial1.dox',
'tutorial2.dox',
'tutorial3.dox',
'tutorial4.dox',
'tutorial5.dox',
'tutorial6.dox',
'spa-index.md',
'spa-design.md',
'spa-pod.md',