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

docs: complete lua Node api docs and fix some ref links

Browse Source
This commit is contained in:
George Kiagiadakis
2021-06-30 19:34:15 +03:00
parent 18fe17fa01
commit 068f7f3000
2 changed files with 59 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/rst/lua_api/lua_object_manager_api.rst
View File

@@ -13,7 +13,7 @@ Constructors
Combines :c:func:`wp_object_manager_new` and
:c:func:`wp_object_manager_add_interest_full`
:param table interest_list: a list of `interests <lua_object_interest_api>`_
:param table interest_list: a list of :ref:`interests <lua_object_interest_api>`
to objects
:returns: a new object manager
:rtype: ObjectManager
@@ -41,15 +41,17 @@ Methods
Binds :c:func:`wp_object_manager_new_filtered_iterator_full`
:param self: the object manager
:param ObjectInterest interest: an interest to filter objects, or nil
:param interest: an interest to filter objects
:type interest: :ref:`Interest <lua_object_interest_api>` or nil or none
:returns: all the managed objects that match the interest
:rtype: Iterator; the iteration items are of type `GObject <lua_gobject>`_
:rtype: Iterator; the iteration items are of type :ref:`GObject <lua_gobject>`
.. function:: ObjectManager.lookup(self, interest)
Binds :c:func:`wp_object_manager_lookup`
:param self: the object manager
:param ObjectInterest interest: the interest to use for the lookup, or nil
:param interest: the interest to use for the lookup
:type interest: :ref:`Interest <lua_object_interest_api>` or nil or none
:returns: the first managed object that matches the interest
:rtype: `GObject <lua_gobject>`_
:rtype: :ref:`GObject <lua_gobject>`