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:
Pauli Virtanen 2021-10-03 23:30:54 +03:00
parent f9cdc617a8
commit 125051a700
11 changed files with 26 additions and 34 deletions

View file

@ -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
\{
\}

View file

@ -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

View file

@ -1,4 +1,4 @@
/** \page page_audio PipeWire Audio
/** \page page_audio Audio
This document explains how Audio is implemented.

View file

@ -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

View file

@ -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

View file

@ -36,12 +36,8 @@
extern "C" {
#endif
/** \defgroup pw_session_manager_impl Implementation
*
*/
/**
* \addtogroup pw_session_manager_impl
* \addtogroup pw_session_manager
* \{
*/

View file

@ -29,7 +29,7 @@
extern "C" {
#endif
/** \defgroup pw_filter Filter API
/** \defgroup pw_filter Filter
*
* \brief PipeWire filter object class
*

View file

@ -31,9 +31,9 @@ extern "C" {
#include <spa/utils/hook.h>
/** \page page_client Client Implementation
/** \page page_client_impl Client Implementation
*
* \section sec_page_client_overview Overview
* \section sec_page_client_impl_overview Overview
*
* The \ref pw_impl_client object is created by a protocol implementation when
* a new client connects.
@ -41,19 +41,19 @@ extern "C" {
* The client is used to keep track of all resources belonging to one
* connection with the PipeWire server.
*
* \section sec_page_client_credentials Credentials
* \section sec_page_client_impl_credentials Credentials
*
* The client object will have its credentials filled in by the protocol.
* This information is used to check if a resource or action is available
* for this client.
*
* \section sec_page_client_types Types
* \section sec_page_client_impl_types Types
*
* The client and server maintain a mapping between the client and server
* types. All type ids that are in messages exchanged between the client
* and server will automatically be remapped.
*
* \section sec_page_client_resources Resources
* \section sec_page_client_impl_resources Resources
*
* When a client binds to context global object, a resource is made for this
* binding and a unique id is assigned to the resources. The client and
@ -70,6 +70,8 @@ extern "C" {
*
* Each client has its own list of resources it is bound to along with
* a mapping between the client types and server types.
*
* See: \ref page_client_impl
*/
/**

View file

@ -60,7 +60,7 @@ extern "C" {
#include <pipewire/utils.h>
#include <pipewire/version.h>
/** \defgroup pw_pipewire Initialization etc.
/** \defgroup pw_pipewire Initialization
*/
/**

View file

@ -29,13 +29,13 @@
extern "C" {
#endif
/** \page page_streams Media Streams
/** \page page_streams Streams
*
* \section sec_overview Overview
*
* Media streams are used to exchange data with the PipeWire server. A
* stream is a wrapper around a proxy for a pw_client_node with
* an adapter. This means the stream will automatically do conversion
* \ref pw_stream "Streams" are used to exchange data with the
* PipeWire server. A stream is a wrapper around a proxy for a pw_client_node
* with an adapter. This means the stream will automatically do conversion
* to the type required by the server.
*
* Streams can be used to:
@ -144,7 +144,7 @@ extern "C" {
*
* Use \ref pw_stream_disconnect() to disconnect a stream after use.
*/
/** \defgroup pw_stream Stream API
/** \defgroup pw_stream Stream
*
* \brief PipeWire stream objects
*