doc: document the core/implementation API split a bit better

Still missing a proper review of the linked objects, but at least this
now explains why those two are split.
This commit is contained in:
Peter Hutterer 2021-08-04 16:33:43 +10:00 committed by Wim Taymans
parent 3370a56e3e
commit 5561531751
6 changed files with 92 additions and 43 deletions

View file

@ -32,21 +32,6 @@ extern "C" {
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
/** \page page_core_api Core API
*
* The Core API serves to access a PipeWire instance. It consists of the
* following object-specific APIs:
*
* - \ref pw_context
* - \ref pw_global
* - \ref pw_client
* - \ref pw_resource
* - \ref pw_node
* - \ref pw_port
* - \ref pw_link
*
*/
/** \defgroup pw_context PipeWire Context
*
* \brief The PipeWire context object manages all locally available

View file

@ -34,11 +34,11 @@ extern "C" {
#include <spa/utils/hook.h>
/** \defgroup pw_core The Core Global Object
/** \defgroup pw_core The PipeWire Core Global Object
*
* \brief The core global object.
*
* This is a special singleton object. It
* This is a special singleton object. It
* is used for internal PipeWire protocol features.
*/

View file

@ -29,7 +29,7 @@
extern "C" {
#endif
/** \defgroup pw_global Global Object
/** \defgroup pw_global PipeWire Global Object
*
* \brief A global object visible to remote clients
*

View file

@ -29,28 +29,6 @@
extern "C" {
#endif
/** \page page_implementation_api Implementation API
*
* The implementation API provides the tools to build new objects and
* modules. It consists of the following object-specific APIs:
*
* - \ref pw_impl_core
* - \ref pw_impl_client
* - \ref pw_impl_device
* - \ref pw_impl_factory
* - \ref pw_impl_link
* - \ref pw_impl_metadata
* - \ref pw_impl_module
* - \ref pw_impl_node
* - \ref pw_impl_port
* - \ref pw_control
* - \ref pw_global
* - \ref pw_resource
* - \ref pw_work_queue
*
*/
struct pw_impl_client;
struct pw_impl_module;
struct pw_global;

View file

@ -31,7 +31,7 @@ extern "C" {
#include <spa/utils/hook.h>
/** \defgroup pw_resource Resources
/** \defgroup pw_resource PipeWire Resources
*
* \brief Client owned objects
*