docs: impl-module: add since markers and improve the Lua doc appearence
This commit is contained in:
@@ -14,12 +14,13 @@ Constructors
|
|||||||
.. function:: LocalModule(name, arguments, properties)
|
.. function:: LocalModule(name, arguments, properties)
|
||||||
|
|
||||||
Loads the named module with the provided arguments and properties (either of
|
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"`.
|
:param string name: the module name, such as ``"libpipewire-module-loopback"``
|
||||||
|
:param string arguments: should be either ``nil`` or a string with the desired
|
||||||
`arguments` should be either `nil` or a string with the desired module
|
module arguments
|
||||||
arguments.
|
:param table properties: can be ``nil`` or a table that can be
|
||||||
|
:ref:`converted <lua_gobject_lua_to_c>` to :c:struct:`WpProperties`
|
||||||
`properties` can be nil or a table that can be :ref:`converted
|
:returns: a new LocalModule
|
||||||
<lua_gobject_lua_to_c>` to :c:struct:`WpProperties`.
|
:rtype: LocalModule (:c:struct:`WpImplModule`)
|
||||||
|
:since: 0.4.2
|
||||||
|
@@ -15,6 +15,7 @@
|
|||||||
/*! \defgroup wpimplmodule WpImplModule */
|
/*! \defgroup wpimplmodule WpImplModule */
|
||||||
/*!
|
/*!
|
||||||
* \struct WpImplModule
|
* \struct WpImplModule
|
||||||
|
* \since 0.4.2
|
||||||
*
|
*
|
||||||
* Used to load PipeWire modules within the WirePlumber process. This is
|
* Used to load PipeWire modules within the WirePlumber process. This is
|
||||||
* slightly different from other objects in that the module is not exported to
|
* slightly different from other objects in that the module is not exported to
|
||||||
@@ -229,6 +230,7 @@ wp_impl_module_class_init (WpImplModuleClass * klass)
|
|||||||
* \brief Loads a PipeWire module into the WirePlumber process
|
* \brief Loads a PipeWire module into the WirePlumber process
|
||||||
*
|
*
|
||||||
* \ingroup wpimplmodule
|
* \ingroup wpimplmodule
|
||||||
|
* \since 0.4.2
|
||||||
* \param core (transfer none): The WirePlumber core
|
* \param core (transfer none): The WirePlumber core
|
||||||
* \param name (transfer none): the name of the module to load
|
* \param name (transfer none): the name of the module to load
|
||||||
* \param arguments (nullable) (transfer none): arguments to be passed to the module
|
* \param arguments (nullable) (transfer none): arguments to be passed to the module
|
||||||
|
@@ -19,6 +19,7 @@ G_BEGIN_DECLS
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
* \brief The WpImplModule GType
|
* \brief The WpImplModule GType
|
||||||
|
* \since 0.4.2
|
||||||
* \ingroup wpimplmodule
|
* \ingroup wpimplmodule
|
||||||
*/
|
*/
|
||||||
#define WP_TYPE_IMPL_MODULE (wp_impl_module_get_type())
|
#define WP_TYPE_IMPL_MODULE (wp_impl_module_get_type())
|
||||||
|
Reference in New Issue
Block a user