Commit d692f06f authored by Raghavendra Rao's avatar Raghavendra Rao Committed by George Kiagiadakis
Browse files

docs: api: Replace hotdoc specific commands with Doxygen specific commands

parent 89549247
.. _client_api:
Pipewire Client
===============
.. doxygenstruct:: WpClient
:project: WirePlumber
:members:
\ No newline at end of file
.. _components_api:
Pipewire Components
===================
.. doxygenstruct:: WpComponentLoader
:project: WirePlumber
:members:
\ No newline at end of file
.. _core_api:
Pipewire Core
=============
.. doxygenstruct:: WpCore
:project: WirePlumber
:members:
\ No newline at end of file
.. _device_api:
Pipewire Device
===============
.. doxygenstruct:: WpDevice
:project: WirePlumber
:members:
\ No newline at end of file
.. _endpoint_api:
Pipewire Endpoint
=================
.. doxygenstruct:: WpEndpoint
:project: WirePlumber
.. _global_proxy_api:
Pipewire Global Object Proxy
============================
.. doxygenstruct:: WpGlobalProxy
:project: WirePlumber
\ No newline at end of file
.. _iterator_api:
Iterator
========
.. doxygenstruct:: WpIterator
:project: WirePlumber
\ No newline at end of file
.. _library_root:
API Documentation
=================
* :ref:`client_api`
* :ref:`components_api`
* :ref:`core_api`
* :ref:`device_api`
* :ref:`endpoint_api`
* :ref:`global_proxy_api`
* :ref:`iterator_api`
* :ref:`link_api`
* :ref:`metadata_api`
* :ref:`node_api`
* :ref:`obj_interest_api`
* :ref:`obj_manager_api`
* :ref:`object_api`
* :ref:`plugin_api`
* :ref:`port_api`
* :ref:`properties_api`
* :ref:`proxy_interfaces_api`
* :ref:`proxy_api`
* :ref:`session_item_api`
* :ref:`si_factory_api`
* :ref:`si_interfaces_api`
* :ref:`state_api`
* :ref:`transitions_api`
* :ref:`spa_type_api`
* :ref:`spa_pod_api`
* :ref:`wp_api`
.. _link_api:
Pipewire Link
=============
.. doxygenstruct:: WpLink
:project: WirePlumber
\ No newline at end of file
# you need to add here any files you add to the api directory as well
files = [
'library_root.rst',
'client_api.rst',
'components_api.rst',
'core_api.rst',
'device_api.rst',
'endpoint_api.rst',
'global_proxy_api.rst',
'iterator_api.rst',
'link_api.rst',
'metadata_api.rst',
'node_api.rst',
'obj_interest_api.rst',
'obj_manager_api.rst',
'object_api.rst',
'plugin_api.rst',
'port_api.rst',
'properties_api.rst',
'proxy_interfaces_api.rst',
'proxy_api.rst',
'session_item_api.rst',
'si_factory_api.rst',
'si_interfaces_api.rst',
'state_api.rst',
'transitions_api.rst',
'spa_type_api.rst',
'spa_pod_api.rst',
'wp_api.rst'
]
foreach file : files
configure_file(input: file, output: file, copy: true)
endforeach
.. _metadata_api:
PipeWire Metadata
=================
.. doxygenstruct:: WpMetadata
:project: WirePlumber
:members:
.. doxygenstruct:: WpImplMetadata
:project: WirePlumber
:members:
\ No newline at end of file
.. _node_api:
PipeWire Node
=============
.. doxygenstruct:: WpNode
:project: WirePlumber
:members:
.. doxygenstruct:: WpImplNode
:project: WirePlumber
:members:
\ No newline at end of file
.. _obj_interest_api:
Object Interest
===============
.. doxygenstruct:: WpObjectInterest
:project: WirePlumber
\ No newline at end of file
.. _obj_manager_api:
Object Manager
==============
.. doxygenstruct:: WpObjectManager
:project: WirePlumber
\ No newline at end of file
.. _object_api:
Base Object Type
================
.. doxygenstruct:: WpObject
:project: WirePlumber
\ No newline at end of file
.. _plugin_api:
Wireplumber Daemon Plugins
==========================
.. doxygenstruct:: WpPlugin
:project: WirePlumber
\ No newline at end of file
.. _port_api:
PipeWire Port
=============
.. doxygenstruct:: WpPort
:project: WirePlumber
\ No newline at end of file
.. _properties_api:
PipeWire Properties Dictionary
==============================
.. doxygenstruct:: WpProperties
:project: WirePlumber
\ No newline at end of file
.. _proxy_api:
PipeWire Object Proxy
=====================
.. doxygenstruct:: WpProxy
:project: WirePlumber
\ No newline at end of file
.. _proxy_interfaces_api:
PipeWire Object Proxy Interfaces
================================
.. doxygenstruct:: WpPipewireObject
:project: WirePlumber
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment