docs: convert lua api docs to pure rst
Not all the docs are there yet, this is WIP
This commit is contained in:
@@ -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
|
||||
|
Reference in New Issue
Block a user