From 125051a700f5c3727ec951c296ef89ea9536faae Mon Sep 17 00:00:00 2001 From: Pauli Virtanen Date: Sun, 3 Oct 2021 23:30:54 +0300 Subject: [PATCH] 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. --- doc/api-tree.dox | 9 +++------ doc/api.dox | 6 ++++-- doc/pipewire-audio.dox | 2 +- doc/{api-library.dox => pipewire-library.dox} | 0 doc/pipewire-objects-design.dox | 2 +- doc/pipewire.dox | 9 ++------- .../extensions/session-manager/impl-interfaces.h | 6 +----- src/pipewire/filter.h | 2 +- src/pipewire/impl-client.h | 12 +++++++----- src/pipewire/pipewire.h | 2 +- src/pipewire/stream.h | 10 +++++----- 11 files changed, 26 insertions(+), 34 deletions(-) rename doc/{api-library.dox => pipewire-library.dox} (100%) diff --git a/doc/api-tree.dox b/doc/api-tree.dox index 02d7c0bd7..40671e178 100644 --- a/doc/api-tree.dox +++ b/doc/api-tree.dox @@ -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 \{ \} diff --git a/doc/api.dox b/doc/api.dox index 231aa304f..880127e90 100644 --- a/doc/api.dox +++ b/doc/api.dox @@ -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 diff --git a/doc/pipewire-audio.dox b/doc/pipewire-audio.dox index 2b428d5b2..3159764cb 100644 --- a/doc/pipewire-audio.dox +++ b/doc/pipewire-audio.dox @@ -1,4 +1,4 @@ -/** \page page_audio PipeWire Audio +/** \page page_audio Audio This document explains how Audio is implemented. diff --git a/doc/api-library.dox b/doc/pipewire-library.dox similarity index 100% rename from doc/api-library.dox rename to doc/pipewire-library.dox diff --git a/doc/pipewire-objects-design.dox b/doc/pipewire-objects-design.dox index d3c2aeb42..2771491c9 100644 --- a/doc/pipewire-objects-design.dox +++ b/doc/pipewire-objects-design.dox @@ -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 diff --git a/doc/pipewire.dox b/doc/pipewire.dox index 569889d0c..3af00c614 100644 --- a/doc/pipewire.dox +++ b/doc/pipewire.dox @@ -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 diff --git a/src/pipewire/extensions/session-manager/impl-interfaces.h b/src/pipewire/extensions/session-manager/impl-interfaces.h index bddf5288c..bc748cd33 100644 --- a/src/pipewire/extensions/session-manager/impl-interfaces.h +++ b/src/pipewire/extensions/session-manager/impl-interfaces.h @@ -36,12 +36,8 @@ extern "C" { #endif -/** \defgroup pw_session_manager_impl Implementation - * - */ - /** - * \addtogroup pw_session_manager_impl + * \addtogroup pw_session_manager * \{ */ diff --git a/src/pipewire/filter.h b/src/pipewire/filter.h index 01b6136a2..eea9487a4 100644 --- a/src/pipewire/filter.h +++ b/src/pipewire/filter.h @@ -29,7 +29,7 @@ extern "C" { #endif -/** \defgroup pw_filter Filter API +/** \defgroup pw_filter Filter * * \brief PipeWire filter object class * diff --git a/src/pipewire/impl-client.h b/src/pipewire/impl-client.h index 9672f65da..3d20ae610 100644 --- a/src/pipewire/impl-client.h +++ b/src/pipewire/impl-client.h @@ -31,9 +31,9 @@ extern "C" { #include -/** \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 */ /** diff --git a/src/pipewire/pipewire.h b/src/pipewire/pipewire.h index 58b4ee1e6..074819fec 100644 --- a/src/pipewire/pipewire.h +++ b/src/pipewire/pipewire.h @@ -60,7 +60,7 @@ extern "C" { #include #include -/** \defgroup pw_pipewire Initialization etc. +/** \defgroup pw_pipewire Initialization */ /** diff --git a/src/pipewire/stream.h b/src/pipewire/stream.h index 2f98ed385..d56563ece 100644 --- a/src/pipewire/stream.h +++ b/src/pipewire/stream.h @@ -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 *