Commit graph

275 commits

Author SHA1 Message Date
Pauli Virtanen 86022d32df doc: disable dot graphs in API docs again
Disable graphs in the layout file. Doxygen seems to ignore Doxyfile
settings if they're enabled in layout.
2024-02-19 21:27:17 +02:00
Pauli Virtanen aec9bc5217 doc: add sections to index, clarify discussion of properties
Add some sections to index + fix typos and section levels.

Clarify discussion of device properties.
2024-02-19 21:21:12 +02:00
Wim Taymans 52f65ccefc docs: add node.rules and device.rules 2024-02-19 10:57:18 +01:00
Pauli Virtanen 04adbebcb1 doc: move config man pages under config/ 2024-02-19 00:00:27 +02:00
Pauli Virtanen 0734381ead doc: add some more coverage
Fix some copypaste mistakes and other errors.

Add explanations for some more properties.  Explain "drop-in" config
files.  Explain filter-chain.conf.

Move configuration man pages under Configuration in TOC.
2024-02-19 00:00:27 +02:00
Pauli Virtanen fd58eec7f8 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.
2024-02-18 15:08:35 +02:00
Pauli Virtanen 715315cbcd doc: fix DoxygenLayout.xml for doxygen 1.10
Run doxygen -l - and make the edits again.
2024-02-18 13:06:08 +02:00
Gleb Popov 0ff7b1464d Use portable shebang in input-filter-h.sh 2024-02-10 20:52:35 +03:00
Wim Taymans cb2b7af8fd tutorial: fix s16 scale and add some docs
The float -> s16 scale value is 32767 or 32768 with clamping. Fix this
and add some docs.

Fixes #3838
2024-02-06 11:38:29 +01:00
Pauli Virtanen e90b2cb338 doc: add 'Configuration' page
Add pointer for readers to Wiki and WirePlumber docs, where the
documentation actually is at, so the configuration docs can found
starting from docs.pipewire.org
2024-02-04 10:29:39 +00:00
Pauli Virtanen 089db6f14a doc: disable deprecated list 2024-01-29 08:50:32 +00:00
Pauli Virtanen 978dbff32f doc: fix some doxygen warnings 2024-01-29 08:50:32 +00:00
Pauli Virtanen b1d88f5ed4 doc: put new pulse modules to right place 2024-01-29 08:50:32 +00:00
Pauli Virtanen cdb6c5a316 doc: filter some constructs that confuse doxygen 2024-01-29 08:50:32 +00:00
shoffmeister c25c7f7bd8 doc: Fix typo 'statis' -> 'static' 2024-01-29 08:47:37 +00:00
Pauli Virtanen bdf96979fc doc: include pipewire-pulse modules explanations also on man page 2023-12-09 16:37:03 +02:00
Pauli Virtanen 31b7ff58ad doc: add pw-v4l2.1 and spa-*.1
Add manpages for the remaining utilities without one.
2023-12-09 16:36:24 +02:00
Pauli Virtanen 80bf28edfd doc: add pw-reserve.1 2023-12-08 18:59:23 +02:00
Pauli Virtanen 9fdf221705 doc: internals/access: update documentation vs current state
Update docs to match implementation.
2023-11-29 18:51:35 +02:00
Pauli Virtanen 53601d44a6 doc: internal/protocol: explain registry generation and protocol footers 2023-11-25 18:39:25 +02:00
Pauli Virtanen ffa52fdbc1 meson.build: separate options for installing man pages or docs 2023-11-25 00:14:18 +02:00
Pauli Virtanen d0ec322434 meson.build: set install tags on doc/man
These are predefined names in meson
2023-11-25 00:13:59 +02:00
Wim Taymans c59820493f docs: add some more doc about the threads 2023-11-23 12:32:35 +01:00
Wim Taymans 900f653860 docs: add some more docs 2023-11-23 10:21:08 +01:00
Pauli Virtanen 0fbcc87314 doc: make all manpages with Doxygen
Use (fixed-up) Doxygen manpage output for all program & module manpages.

This also allows formatting the manual pages properly in the HTML docs.

The Markdown pages work properly only with Doxygen >= 1.9.7, older
versions put them to wrong place in the HTML docs.
2023-11-22 20:10:49 +02:00
tytan652 33a3990c3c doc: fix xdg-desktop-portal documentation links 2023-11-21 21:25:13 +01:00
Pauli Virtanen c29d4d4ab7 meson.build: make pandoc optional
Skip only pandoc-requiring parts if it is not available.
2023-11-21 17:00:45 +00:00
Pauli Virtanen 843e733479 doc: add documentation for pipewire-pulse modules
Add (minimal) reference documentation for each pipewire-pulse module.

Add some preprocessing to substitute @pulse_module_options@ in docs from
PW_KEY_MODULE_USAGE so the module options don't need to be repeated.

Produce Doxygen docs + generate manpages pipewire-pulse-modules.7,
pipewire-pulse-module-*.7
2023-11-20 08:41:13 +00:00
Pauli Virtanen 21854f24a5 doc: generate man-pages also for pipewire modules
Use pandoc + some processing to convert Doxygen html output to man
pages.

Requires pandoc & python for building.

Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-19 16:39:15 +00:00
Pauli Virtanen 77fad4ee13 doc: reorganize files
Separate various autogen files from the documentation .dox files.
Rename .dox files to match the intended tree structure.
2023-11-19 16:39:15 +00:00
Pauli Virtanen c77fdb4864 doc: hide useless indices in doxygen output etc. fixes
Hide useless paginated indices.
Rename "Related Pages" -> "Pages".
Fix manpage brief description.
Fix file path name stripping.
Move macro listings after enums, so that they're next to functions.
Remove pwtest from docs, it's not API.
Fixup header styles.
2023-11-04 15:22:01 +02:00
Pauli Virtanen 27afa39d5d doc: use b->requested in tutorial4 2023-11-04 14:50:45 +02:00
Pauli Virtanen 49668a9b26 doc: fixup some Doxygen autogen issues
Don't show page sections in left sidebar, it's confusing.
Rename Modules -> API Reference in sidebar.
Indicate visually the sidebar entries are collapsible.
Fix spa_pod_json grouping.
Move tools page to top level.
Fix page ordering.
2023-11-04 09:45:55 +00:00
Jan Alexander Steffens (heftig) 43db03909b ci: ShellCheck preprocessed scripts separately
Change the shellcheck job so that we configure the build and check the
preprocessed versions of the scripts, not the bare ones, which might not
be syntactically valid yet.
2023-09-15 08:49:36 +00:00
Arun Raghavan 86bd0eb708 logger: Add a mechanism to force colourised logging
This is handy if we want to redirect to a file but have colours to make
manual parsing easier (for example with `less -R`).
2023-08-08 17:13:31 +00:00
columbarius 96bb44e290 doc/dma-buf: Use references and other small fixes 2023-08-08 07:00:11 +00:00
columbarius 49bbe1b4e5 doc/dma-buf: Document usage of SPA_VIDEO_FLAG_MODIFIER flags 2023-08-04 01:48:46 +02:00
Wim Taymans ce8f2c5d10 modules-vban: add vban sender and receiver
Fixes #3380
2023-07-25 18:36:48 +02:00
Wim Taymans 4b32b1fef0 modules: add example filter 2023-06-27 14:02:38 +02:00
Théo Lebrun 59756a7c5d examples: fix indent 2023-06-09 17:06:25 +00:00
Wim Taymans f9b2df25c7 docs: clarify writefd in transport 2023-06-06 11:02:43 +02:00
Wim Taymans c3b01eee97 doc: clarify proxy/resource 2023-06-06 10:54:53 +02:00
Wim Taymans 2a00b784fa doc: small improvement 2023-06-06 10:44:39 +02:00
Wim Taymans 22acf94f7d docs: add netjack2 manager 2023-06-05 10:44:07 +02:00
Wim Taymans fe99990e0f doc: update with netjack2 driver 2023-05-31 17:38:05 +02:00
Wim Taymans 3626b1e90e module-ffado: add docs 2023-05-29 09:19:29 +02:00
Wim Taymans 3b5fd0bd7a doc: fix pod sizes 2023-05-23 09:30:36 +02:00
Wim Taymans 83718f431b doc: update 2023-05-23 09:19:35 +02:00
Arun Raghavan b216a2cfb0 doc: Some minor fixups to the scheduling doc
s/evenfd/eventfd and some minor formatting.
2023-05-18 14:58:49 -03:00
Wim Taymans 957470bd9f doc: add more docs 2023-05-16 16:15:54 +02:00