docs: convert lua api docs to pure rst

Not all the docs are there yet, this is WIP
This commit is contained in:
George Kiagiadakis
2021-05-25 13:46:20 +03:00
parent c3ee52506b
commit e567637d37
22 changed files with 337 additions and 456 deletions

View File

@@ -1,8 +1,24 @@
.. _lua_object_interest_api:
Lua Object Interest Documentation
---------------------------------
Object Interest
===============
.. doxygenstruct:: ObjectInterest
:project: WirePlumber_Lua
:members:
Constructors
~~~~~~~~~~~~
.. function:: Interest(decl)
:param table decl: an interest declaration
:returns: the interest
:rtype: ObjectInterest
Methods
~~~~~~~
.. function:: Interest.matches(self, obj)
:param self: the interest
:param obj: an object to check for a match
:type obj: GObject or table
:returns: whether the object matches the interest
:rtype: boolean