colin/wireplumber
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: impl-module: add since markers and improve the Lua doc appearence

Browse Source
This commit is contained in:
George Kiagiadakis
2021-08-19 17:58:07 +03:00
parent 8949e98d1f
commit cef9b00daf
3 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/rst/lua_api/lua_local_module_api.rst
View File

@@ -14,12 +14,13 @@ Constructors
.. function:: LocalModule(name, arguments, properties)
Loads the named module with the provided arguments and properties (either of
which can be nil).
which can be ``nil``).
`name` is the module name, such as `"libpipewire-module-loopback"`.
`arguments` should be either `nil` or a string with the desired module
arguments.
`properties` can be nil or a table that can be :ref:`converted
<lua_gobject_lua_to_c>` to :c:struct:`WpProperties`.
:param string name: the module name, such as ``"libpipewire-module-loopback"``
:param string arguments: should be either ``nil`` or a string with the desired
module arguments
:param table properties: can be ``nil`` or a table that can be
:ref:`converted <lua_gobject_lua_to_c>` to :c:struct:`WpProperties`
:returns: a new LocalModule
:rtype: LocalModule (:c:struct:`WpImplModule`)
:since: 0.4.2