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

docs: Add Lua API documentation

parent d692f06f
......@@ -34,7 +34,7 @@ extensions = [
'breathe',
]
breathe_projects = { "WirePlumber": "@BUILD_ROOT@/xml" }
breathe_projects = { "WirePlumber": "@BUILD_ROOT@/xml", "WirePlumber_Lua" : "@BUILD_ROOT@/xml", }
breathe_default_members = ('members', 'undoc-members')
breathe_default_project = "WirePlumber"
......
......@@ -794,6 +794,8 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched.
INPUT = @SRC_ROOT@/lib/wp
INPUT += @SRC_ROOT@/modules/module-lua-scripting/api.c
INPUT += @SRC_ROOT@/modules/module-lua-scripting/pod.c
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......
......@@ -43,6 +43,7 @@ Subpages
* :ref:`installing-wireplumber`
* :ref:`running-wireplumber-daemon`
* :ref:`daemon-configuration`
* :ref:`lua_api`
* :ref:`contributing`
* :ref:`testing`
* :ref:`community`
......
.. _lua_api:
Lua API Documentation
=====================
* :ref:`lua_core_api`
* :ref:`lua_client_api`
* :ref:`lua_endpoint_api`
* :ref:`lua_global_proxy_api`
* :ref:`lua_metadata_api`
* :ref:`lua_node_api`
* :ref:`lua_object_api`
* :ref:`lua_object_interest_api`
* :ref:`lua_object_manager_api`
* :ref:`lua_pipewire_object_api`
* :ref:`lua_proxy_api`
* :ref:`lua_session_bin_api`
* :ref:`lua_session_item_api`
* :ref:`lua_source_api`
* :ref:`lua_spa_device_api`
.. _lua_client_api:
Lua Client Documentation
------------------------
.. doxygenstruct:: Client
:project: WirePlumber_Lua
:members:
.. _lua_core_api:
Lua Core Documentation
----------------------
.. doxygenstruct:: Core
:project: WirePlumber_Lua
:members:
\ No newline at end of file
.. _lua_endpoint_api:
Lua Endpoint Documentation
--------------------------
.. doxygenstruct:: Endpoint
:project: WirePlumber_Lua
:members:
.. _lua_global_proxy_api:
Lua Global Proxy Documentation
------------------------------
.. doxygenstruct:: GlobalProxy
:project: WirePlumber_Lua
:members:
.. _lua_metadata_api:
Lua Metadata Documentation
--------------------------
.. doxygenstruct:: Metadata
:project: WirePlumber_Lua
:members:
.. _lua_node_api:
Lua Node Documentation
----------------------
.. doxygenstruct:: Node
:project: WirePlumber_Lua
:members:
.. _lua_object_api:
Lua Object Documentation
------------------------
.. doxygenstruct:: Object
:project: WirePlumber_Lua
:members:
.. _lua_object_interest_api:
Lua Object Interest Documentation
---------------------------------
.. doxygenstruct:: ObjectInterest
:project: WirePlumber_Lua
:members:
.. _lua_object_manager_api:
Lua Object Manager Documentation
---------------------------------
.. doxygenstruct:: ObjectManager
:project: WirePlumber_Lua
:members:
.. _lua_pipewire_object_api:
Lua PipewireObject Documentation
------------------------
.. doxygenstruct:: PipewireObject
:project: WirePlumber_Lua
:members:
.. _lua_proxy_api:
Lua Proxy Documentation
-----------------------
.. doxygenstruct:: Proxy
:project: WirePlumber_Lua
:members:
.. _lua_session_bin_api:
Lua Session Bin Documentation
------------------------------
.. doxygenstruct:: SessionBin
:project: WirePlumber_Lua
:members:
.. _lua_session_item_api:
Lua Session Item Documentation
------------------------------
.. doxygenstruct:: SessionItem
:project: WirePlumber_Lua
:members:
.. _lua_source_api:
Lua Source Documentation
------------------------
.. doxygenstruct:: Source
:project: WirePlumber_Lua
:members:
.. _lua_spa_device_api:
Lua Spa Device Documentation
----------------------------
.. doxygenstruct:: SpaDevice
:project: WirePlumber_Lua
:members:
# you need to add here any files you add to the toc directory as well
files = [
'lua_core_api.rst',
'lua_client_api.rst',
'lua_endpoint_api.rst',
'lua_global_proxy_api.rst',
'lua_metadata_api.rst',
'lua_node_api.rst',
'lua_object_api.rst',
'lua_object_interest_api.rst',
'lua_object_manager_api.rst',
'lua_pipewire_object_api.rst',
'lua_proxy_api.rst',
'lua_session_bin_api.rst',
'lua_session_item_api.rst',
'lua_source_api.rst',
'lua_spa_device_api.rst',
]
foreach file : files
configure_file(input: file, output: file, copy: true)
endforeach
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