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/dox/tutorial/index.dox

22 lines
502 B
Text
Raw Normal View History

doc: add reference docs + index for config and env variables Add reference documentation for configuration settings & node/device properties. We should have boring & exhaustive reference lists of all the options, and an index where they can be looked up as needed. The content is mostly stolen from the Wiki. Add pipewire-client.conf.5, pipewire-jack.conf.5, and pipewire-device.7 that try to explain all available configuration settings for native/ALSA/JACK clients, and parameters & properties devices. Expand pipewire.conf.5 and pipewire-pulse.conf.5 with lists of supported properties. Also explain environment variables. Doxygen doesn't have an indexing mechanism suitable for configuration settings, so add a simple one using an input filter and use it here. Tweak styling a bit.
2023-12-09 18:34:56 +02:00
/** \page page_tutorial API Tutorial
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
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 15:13:05 +02:00
Welcome to the PipeWire API tutorial. The goal is to learn
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
PipeWire API step-by-step with simple short examples.
- \subpage page_tutorial1
- \subpage page_tutorial2
- \subpage page_tutorial3
- \subpage page_tutorial4
- \subpage page_tutorial5
- \subpage page_tutorial6
doc: add DSP filter tutorial Add CLAUDE generated tutorial7 based on the audio-dsp-filter example.
2025-09-22 10:55:32 +02:00
- \subpage page_tutorial7
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
Documentation Updates
2022-05-08 17:06:28 +00:00
# More Example Programs
doc: link examples to Doxygen docs Include examples to the documentation, using Doxygen's example system.
2021-10-09 23:25:29 +03:00
- \ref audio-src.c "": \snippet{doc} audio-src.c title
- \ref video-play.c "": \snippet{doc} video-play.c title
- \subpage page_examples
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
*/
Reference in a new issue Copy permalink