mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
doc: reorganize some \pages, and fix some group names
Move \pages having to do with the API usage to the API section. Better group names for some groups.
This commit is contained in:
parent
f9cdc617a8
commit
125051a700
11 changed files with 26 additions and 34 deletions
|
|
@ -4,6 +4,7 @@
|
|||
\brief PipeWire Core API
|
||||
\{
|
||||
\addtogroup pw_pipewire
|
||||
\addtogroup pw_main_loop
|
||||
\addtogroup pw_context
|
||||
\addtogroup pw_client
|
||||
\addtogroup pw_core
|
||||
|
|
@ -50,7 +51,6 @@
|
|||
\addtogroup pw_conf
|
||||
\addtogroup pw_gettext
|
||||
\addtogroup pw_log
|
||||
\addtogroup pw_main_loop
|
||||
\addtogroup pw_map
|
||||
\addtogroup pw_memblock
|
||||
\addtogroup pw_properties
|
||||
|
|
@ -66,9 +66,6 @@
|
|||
\addtogroup pw_profiler
|
||||
\addtogroup pw_protocol_native
|
||||
\addtogroup pw_session_manager
|
||||
\{
|
||||
\addtogroup pw_session_manager_impl
|
||||
\}
|
||||
\}
|
||||
|
||||
\defgroup api_spa SPA
|
||||
|
|
@ -112,11 +109,11 @@
|
|||
\}
|
||||
\}
|
||||
|
||||
\defgroup pw_stream Stream API
|
||||
\defgroup pw_stream Stream
|
||||
\{
|
||||
\}
|
||||
|
||||
\defgroup pw_filter Filter API
|
||||
\defgroup pw_filter Filter
|
||||
\{
|
||||
\}
|
||||
|
||||
|
|
|
|||
|
|
@ -59,8 +59,10 @@ digraph API {
|
|||
It is common for clients to use both the \ref api_pw_core and the \ref api_pw_impl
|
||||
and both APIs are provided by the same library.
|
||||
|
||||
|
||||
|
||||
- \subpage page_client_impl
|
||||
- \subpage page_proxy
|
||||
- \subpage page_streams
|
||||
- \subpage page_thread_loop
|
||||
|
||||
|
||||
\addtogroup api_pw_core Core API
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/** \page page_audio PipeWire Audio
|
||||
/** \page page_audio Audio
|
||||
|
||||
This document explains how Audio is implemented.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/** \page page_objects_design PipeWire Objects Design
|
||||
/** \page page_objects_design Objects Design
|
||||
|
||||
This document is a design reference on the various objects that exist
|
||||
in the PipeWire media and session management graphs, explaining what these
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/** \page page_pipewire PipeWire
|
||||
/** \page page_pipewire PipeWire Design
|
||||
|
||||
## Internals
|
||||
|
||||
|
|
@ -7,20 +7,15 @@
|
|||
- \subpage page_access
|
||||
- \subpage page_portal
|
||||
- \subpage page_midi
|
||||
- \subpage page_streams
|
||||
- \subpage page_client
|
||||
- \subpage page_proxy
|
||||
- \subpage page_thread_loop
|
||||
- \subpage page_objects_design
|
||||
- \subpage page_library
|
||||
- \subpage page_dma_buf
|
||||
|
||||
## Components
|
||||
|
||||
- \subpage page_daemon
|
||||
- \subpage page_library
|
||||
- \subpage page_tools
|
||||
- \subpage page_session_manager
|
||||
- \ref page_spa
|
||||
|
||||
## Backends
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue