From ed8346e77d451a2bcc0fd000c1a252a542a06d24 Mon Sep 17 00:00:00 2001
From: Jason Francis <zxzax@protonmail.com>
Date: Tue, 1 Jun 2021 19:39:13 -0400
Subject: [PATCH] docs: Add brief descriptions to all functions

This ensures all of these functions are picked up by g-ir-scanner.
---
 lib/wp/core.c             | 18 ++++++++++++++++++
 lib/wp/device.c           |  8 ++++++++
 lib/wp/endpoint.c         |  2 ++
 lib/wp/global-proxy.c     |  2 ++
 lib/wp/iterator.c         |  6 +++++-
 lib/wp/log.c              |  1 +
 lib/wp/metadata.c         |  1 +
 lib/wp/node.c             |  6 ++++--
 lib/wp/object-interest.c  |  2 ++
 lib/wp/object-manager.c   | 15 ++++++++++-----
 lib/wp/object.c           |  5 +++++
 lib/wp/plugin.c           |  4 ++++
 lib/wp/port.c             |  1 +
 lib/wp/properties.c       | 12 ++++++++++++
 lib/wp/proxy-interfaces.c |  2 ++
 lib/wp/proxy.c            |  2 ++
 lib/wp/session-item.c     | 10 ++++++++++
 lib/wp/si-factory.c       |  6 ++++++
 lib/wp/si-interfaces.c    | 12 ++++++++++++
 lib/wp/spa-pod.c          |  8 ++++++++
 lib/wp/spa-type.c         | 24 ++++++++++++++++++++++++
 lib/wp/spa-type.h         |  4 ++++
 lib/wp/state.c            |  3 +++
 lib/wp/transition.c       |  2 ++
 lib/wp/wp.c               |  8 ++++++--
 25 files changed, 154 insertions(+), 10 deletions(-)

diff --git a/lib/wp/core.c b/lib/wp/core.c
index 1430b106..27467067 100644
--- a/lib/wp/core.c
+++ b/lib/wp/core.c
@@ -424,6 +424,8 @@ wp_core_class_init (WpCoreClass * klass)
 }
 
 /*!
+ * \brief Creates a new core object
+ *
  * \ingroup wpcore
  * \param context (transfer none) (nullable): the GMainContext to use for events
  * \param properties (transfer full) (nullable): additional properties, which are
@@ -459,6 +461,8 @@ wp_core_clone (WpCore * self)
 }
 
 /*!
+ * \brief Gets the GMainContext of the core
+ *
  * \ingroup wpcore
  * \param self the core
  * \returns (transfer none) (nullable): the GMainContext that is in
@@ -472,6 +476,8 @@ wp_core_get_g_main_context (WpCore * self)
 }
 
 /*!
+ * \brief Gets the internal PipeWire context of the core
+ *
  * \ingroup wpcore
  * \param self the core
  * \returns (transfer none): the internal pw_context object
@@ -484,6 +490,8 @@ wp_core_get_pw_context (WpCore * self)
 }
 
 /*!
+ * \brief Gets the internal PipeWire core of the core
+ *
  * \ingroup wpcore
  * \param self the core
  * \returns (transfer none) (nullable): the internal pw_core object,
@@ -556,6 +564,8 @@ wp_core_disconnect (WpCore *self)
 }
 
 /*!
+ * \brief Checks if the core is connected to PipeWire
+ *
  * \ingroup wpcore
  * \param self the core
  * \returns TRUE if the core is connected to PipeWire, FALSE otherwise
@@ -568,6 +578,8 @@ wp_core_is_connected (WpCore * self)
 }
 
 /*!
+ * \brief Gets the cookie of the core's connected PipeWire instance
+ *
  * \ingroup wpcore
  * \param self the core
  * \returns The cookie of the PipeWire instance that \a self is connected to.
@@ -584,6 +596,7 @@ wp_core_get_remote_cookie (WpCore * self)
 }
 
 /*!
+ * \brief Gets the name of the core's connected PipeWire instance
  * \ingroup wpcore
  * \param self the core
  * \returns The name of the PipeWire instance that \a self is connected to
@@ -598,6 +611,7 @@ wp_core_get_remote_name (WpCore * self)
 }
 
 /*!
+ * \brief Gets the user name of the core's connected PipeWire instance
  * \ingroup wpcore
  * \param self the core
  * \returns The name of the user that started the PipeWire instance that
@@ -613,6 +627,7 @@ wp_core_get_remote_user_name (WpCore * self)
 }
 
 /*!
+ * \brief Gets the host name of the core's connected PipeWire instance
  * \ingroup wpcore
  * \param self the core
  * \returns The name of the host where the PipeWire instance that
@@ -628,6 +643,7 @@ wp_core_get_remote_host_name (WpCore * self)
 }
 
 /*!
+ * \brief Gets the version of the core's connected PipeWire instance
  * \ingroup wpcore
  * \param self the core
  * \returns The version of the PipeWire instance that \a self is connected to
@@ -642,6 +658,7 @@ wp_core_get_remote_version (WpCore * self)
 }
 
 /*!
+ * \brief Gets the properties of the core's connected PipeWire instance
  * \ingroup wpcore
  * \param self the core
  * \returns (transfer full): the properties of the PipeWire instance that
@@ -657,6 +674,7 @@ wp_core_get_remote_properties (WpCore * self)
 }
 
 /*!
+ * \brief Gets the properties of the core
  * \ingroup wpcore
  * \param self the core
  * \returns (transfer full): the properties of \a self
diff --git a/lib/wp/device.c b/lib/wp/device.c
index d2397a89..5fe537fc 100644
--- a/lib/wp/device.c
+++ b/lib/wp/device.c
@@ -564,6 +564,8 @@ wp_spa_device_class_init (WpSpaDeviceClass * klass)
 }
 
 /*!
+ * \brief Constructs an SPA Device object from an existing device handle.
+ *
  * \ingroup wpspadevice
  * \param core the wireplumber core
  * \param spa_device_handle the spa device handle
@@ -622,6 +624,8 @@ wp_spa_device_new_from_spa_factory (WpCore * core,
 }
 
 /*!
+ * \brief Gets the properties of this device.
+ *
  * \ingroup wpspadevice
  * \param self the spa device
  * \returns (transfer full): the device properties
@@ -634,6 +638,8 @@ wp_spa_device_get_properties (WpSpaDevice * self)
 }
 
 /*!
+ * \brief Gets one of the objects managed by this device.
+ *
  * \ingroup wpspadevice
  * \param self the spa device
  * \param id the (device-internal) id of the object to get
@@ -650,6 +656,8 @@ wp_spa_device_get_managed_object (WpSpaDevice * self, guint id)
 }
 
 /*!
+ * \brief Stores or removes a managed object into/from a device.
+ *
  * \ingroup wpspadevice
  * \param self the spa device
  * \param id the (device-internal) id of the object
diff --git a/lib/wp/endpoint.c b/lib/wp/endpoint.c
index d4efa2db..c245896d 100644
--- a/lib/wp/endpoint.c
+++ b/lib/wp/endpoint.c
@@ -674,6 +674,8 @@ wp_endpoint_impl_pw_object_mixin_priv_interface_init (
 }
 
 /*!
+ * \brief Creates a new endpoint implementation
+ *
  * \ingroup wpendpoint
  * \param core the core
  * \param item the session item that implements the endpoint
diff --git a/lib/wp/global-proxy.c b/lib/wp/global-proxy.c
index b8725f2e..71f45b08 100644
--- a/lib/wp/global-proxy.c
+++ b/lib/wp/global-proxy.c
@@ -327,6 +327,7 @@ wp_global_proxy_request_destroy (WpGlobalProxy * self)
 }
 
 /*!
+ * \brief Gets the permissions of a pipewire global
  * \ingroup wpglobalproxy
  * \param self the pipewire global
  * \returns the permissions that wireplumber has on this object
@@ -343,6 +344,7 @@ wp_global_proxy_get_permissions (WpGlobalProxy * self)
 }
 
 /*!
+ * \brief Gets the global properties of a pipewire global
  * \ingroup wpglobalproxy
  * \param self the pipewire global
  * \returns (transfer full): the global (immutable) properties of this
diff --git a/lib/wp/iterator.c b/lib/wp/iterator.c
index fbf65830..6cbbd12d 100644
--- a/lib/wp/iterator.c
+++ b/lib/wp/iterator.c
@@ -93,6 +93,7 @@ wp_iterator_new (const WpIteratorMethods *methods, size_t user_size)
 }
 
 /*!
+ * \brief Gets the implementation-specific storage of an iterator
  * \note this only for use by implementations of WpIterator
  *
  * \protected
@@ -107,6 +108,7 @@ wp_iterator_get_user_data (WpIterator *self)
 }
 
 /*!
+ * \brief Increases the reference count of an iterator
  * \ingroup wpiterator
  * \param self an iterator object
  * \returns (transfer full): \a self with an additional reference count on it
@@ -281,8 +283,10 @@ static const WpIteratorMethods ptr_array_iterator_methods = {
 };
 
 /*!
+ * \brief Creates an iterator from a pointer array
+ *
  * \ingroup wpiterator
- * \param items (element-type utf8) (transfer full): the items to iterate over
+ * \param items (element-type gpointer) (transfer full): the items to iterate over
  * \param item_type the type of each item
  * \returns (transfer full): a new iterator that iterates over \a items
  */
diff --git a/lib/wp/log.c b/lib/wp/log.c
index 13661300..b7ecf954 100644
--- a/lib/wp/log.c
+++ b/lib/wp/log.c
@@ -616,6 +616,7 @@ static struct spa_log wp_spa_log = {
 };
 
 /*!
+ * \brief Gets WirePlumber's instance of `spa_log`
  * \ingroup wplog
  * \returns WirePlumber's instance of `spa_log`, which can be used to redirect
  *   PipeWire's log messages to the currently installed GLogWriterFunc.
diff --git a/lib/wp/metadata.c b/lib/wp/metadata.c
index 9b658a79..dc94ee62 100644
--- a/lib/wp/metadata.c
+++ b/lib/wp/metadata.c
@@ -695,6 +695,7 @@ wp_impl_metadata_class_init (WpImplMetadataClass * klass)
 }
 
 /*!
+ * \brief Creates a new metadata implementation
  * \ingroup wpmetadata
  * \param core the core
  * \returns (transfer full): a new WpImplMetadata
diff --git a/lib/wp/node.c b/lib/wp/node.c
index c1be1f16..026b3d8d 100644
--- a/lib/wp/node.c
+++ b/lib/wp/node.c
@@ -314,9 +314,10 @@ wp_node_new_from_factory (WpCore * core,
 }
 
 /*!
+ * \brief Gets the current state of the node
  * \ingroup wpnode
  * \param self the node
- * \param error the error
+ * \param error (out) (optional) (transfer none): the error
  * \returns the current state of the node
  */
 WpNodeState
@@ -771,9 +772,10 @@ wp_impl_node_pw_object_mixin_priv_interface_init (
 }
 
 /*!
+ * \brief Constructs a node object from an existing `pw_impl_node`.
  * \ingroup wpimplnode
  * \param core the wireplumber core
- * \param node an existing pw_impl_node to wrap
+ * \param node an existing `pw_impl_node` to wrap
  * \returns (transfer full): A new WpImplNode wrapping \a node
  */
 WpImplNode *
diff --git a/lib/wp/object-interest.c b/lib/wp/object-interest.c
index 84f59bea..69072fb9 100644
--- a/lib/wp/object-interest.c
+++ b/lib/wp/object-interest.c
@@ -245,6 +245,7 @@ wp_object_interest_add_constraint (WpObjectInterest * self,
 }
 
 /*!
+ * \brief Creates a deep copy of an object interest
  * \ingroup wpobjectinterest
  * \param self the object interest to copy
  * \returns (transfer full): a deep copy of \a self
@@ -276,6 +277,7 @@ wp_object_interest_copy (WpObjectInterest * self)
 }
 
 /*!
+ * \brief Increases the reference count of an object interest
  * \ingroup wpobjectinterest
  * \param self the object interest to ref
  * \returns (transfer full): \a self with an additional reference count on it
diff --git a/lib/wp/object-manager.c b/lib/wp/object-manager.c
index 48a461eb..cfddf57f 100644
--- a/lib/wp/object-manager.c
+++ b/lib/wp/object-manager.c
@@ -246,6 +246,7 @@ wp_object_manager_new (void)
 }
 
 /*!
+ * \brief Checks if an object manager is installed.
  * \ingroup wpobjectmanager
  * \param self the object manager
  * \returns TRUE if the object manager is installed (i.e. the
@@ -359,6 +360,7 @@ wp_object_manager_request_object_features (WpObjectManager *self,
 }
 
 /*!
+ * \brief Gets the number of objects managed by the object manager.
  * \ingroup wpobjectmanager
  * \param self the object manager
  * \returns the number of objects managed by this WpObjectManager
@@ -445,6 +447,7 @@ static const WpIteratorMethods om_iterator_methods = {
 };
 
 /*!
+ * \brief Iterates through all the objects managed by this object manager.
  * \ingroup wpobjectmanager
  * \param self the object manager
  * \returns (transfer full): a WpIterator that iterates over all the managed
@@ -1155,7 +1158,7 @@ wp_registry_prepare_new_global (WpRegistry * self, guint32 id,
 }
 
 /*
- * Finds a registered object
+ * \brief Finds a registered object
  *
  * \param reg the registry
  * \param func (scope call): a function that takes the object being searched
@@ -1185,9 +1188,11 @@ wp_registry_find_object (WpRegistry *reg, GEqualFunc func, gconstpointer data)
 }
 
 /*
- * Registers \a obj with the core, making it appear on WpObjectManager
- * instances as well. The core will also maintain a ref to that object
- * until it is removed.
+ * \brief Registers \a obj with the core, making it appear on WpObjectManager
+ * instances as well.
+ *
+ * The core will also maintain a ref to that object until it
+ * is removed.
  *
  * \param reg the registry
  * \param obj (transfer full) (type GObject*): the object to register
@@ -1210,7 +1215,7 @@ wp_registry_register_object (WpRegistry *reg, gpointer obj)
 }
 
 /*
- * Detaches and unrefs the specified object from this core
+ * \brief Detaches and unrefs the specified object from this core.
  *
  * \param reg the registry
  * \param obj (transfer none) (type GObject*): a pointer to the object to remove
diff --git a/lib/wp/object.c b/lib/wp/object.c
index 18198017..4fee3f57 100644
--- a/lib/wp/object.c
+++ b/lib/wp/object.c
@@ -103,6 +103,7 @@ wp_feature_activation_transition_class_init (
 }
 
 /*!
+ * \brief Gets the features requested to be activated in this transition.
  * \ingroup wpfeatureactivationtransition
  * \param self the transition
  * \returns the features that were requested to be activated in this transition;
@@ -266,6 +267,8 @@ wp_object_class_init (WpObjectClass * klass)
 }
 
 /*!
+ * \brief Gets the core associated with this object.
+ *
  * \ingroup wpobject
  * \param self the object
  * \returns (transfer full): the core associated with this object
@@ -280,6 +283,7 @@ wp_object_get_core (WpObject * self)
 }
 
 /*!
+ * \brief Gets the active features of this object.
  * \ingroup wpobject
  * \param self the object
  * \returns A bitset containing the active features of this object
@@ -294,6 +298,7 @@ wp_object_get_active_features (WpObject * self)
 }
 
 /*!
+ * \brief Gets the supported features of this object.
  * \ingroup wpobject
  * \param self the object
  * \returns A bitset containing the supported features of this object;
diff --git a/lib/wp/plugin.c b/lib/wp/plugin.c
index 7981431d..b791e91f 100644
--- a/lib/wp/plugin.c
+++ b/lib/wp/plugin.c
@@ -192,6 +192,8 @@ find_plugin_func (gpointer plugin, gpointer name_quark)
 }
 
 /*!
+ * \brief Looks up a plugin.
+ *
  * \ingroup wpplugin
  * \param core the core
  * \param plugin_name the lookup name
@@ -211,6 +213,8 @@ wp_plugin_find (WpCore * core, const gchar * plugin_name)
 }
 
 /*!
+ * \brief Retreives the name of a plugin.
+ *
  * \ingroup wpplugin
  * \param self the plugin
  * \returns the name of this plugin
diff --git a/lib/wp/port.c b/lib/wp/port.c
index ccfe9856..87483725 100644
--- a/lib/wp/port.c
+++ b/lib/wp/port.c
@@ -135,6 +135,7 @@ wp_port_pw_object_mixin_priv_interface_init (
 }
 
 /*!
+ * \brief Gets the current direction of the port
  * \ingroup wpport
  * \param self the port
  * \returns the current direction of the port
diff --git a/lib/wp/properties.c b/lib/wp/properties.c
index 539dda42..e7bf7637 100644
--- a/lib/wp/properties.c
+++ b/lib/wp/properties.c
@@ -625,6 +625,8 @@ wp_properties_add_keys_array (WpProperties * self, WpProperties * props,
 }
 
 /*!
+ * \brief Looks up a given property value from a key
+ *
  * \ingroup wpproperties
  * \param self a properties object
  * \param key a property key
@@ -778,6 +780,8 @@ static const WpIteratorMethods dict_iterator_methods = {
 };
 
 /*!
+ * \brief Iterates through all the properties in the properties object
+ *
  * \ingroup wpproperties
  * \param self a properties object
  * \returns (transfer full): an iterator that iterates over the properties.
@@ -802,6 +806,8 @@ wp_properties_new_iterator (WpProperties * self)
 }
 
 /*!
+ * \brief Gets the key from a properties iterator item
+ *
  * \ingroup wpproperties
  * \param item a GValue that was returned from the WpIterator of
  *   wp_properties_new_iterator()
@@ -816,6 +822,8 @@ wp_properties_iterator_item_get_key (const GValue * item)
 }
 
 /*!
+ * \brief Gets the value from a properties iterator item
+ *
  * \ingroup wpproperties
  * \param item a GValue that was returned from the WpIterator of
  *   wp_properties_new_iterator()
@@ -845,6 +853,8 @@ wp_properties_sort (WpProperties * self)
 }
 
 /*!
+ * \brief Gets the dictionary wrapped by a properties object
+ *
  * \ingroup wpproperties
  * \param self a properties object
  * \returns (transfer none): the internal properties set as a `struct spa_dict *`
@@ -858,6 +868,8 @@ wp_properties_peek_dict (WpProperties * self)
 }
 
 /*!
+ * \brief Gets a copy of the properties object as a `struct pw_properties`
+ *
  * \ingroup wpproperties
  * \param self a properties object
  * \returns (transfer full): a copy of the properties in \a self
diff --git a/lib/wp/proxy-interfaces.c b/lib/wp/proxy-interfaces.c
index a2727b7e..ac8bc4a7 100644
--- a/lib/wp/proxy-interfaces.c
+++ b/lib/wp/proxy-interfaces.c
@@ -228,6 +228,8 @@ wp_pipewire_object_enum_params (WpPipewireObject * self, const gchar * id,
 }
 
 /*!
+ * \brief Finishes an asynchronous parameter enumeration operation.
+ *
  * \ingroup wppipewireobject
  * \param self the pipewire object
  * \param res the async result
diff --git a/lib/wp/proxy.c b/lib/wp/proxy.c
index 71c106b9..b1cb983a 100644
--- a/lib/wp/proxy.c
+++ b/lib/wp/proxy.c
@@ -274,6 +274,7 @@ wp_proxy_get_bound_id (WpProxy * self)
 }
 
 /*!
+ * \brief Gets the interface type of the proxied object
  * \ingroup wpproxy
  * \param self the proxy
  * \param version (out) (optional): the version of the interface
@@ -296,6 +297,7 @@ wp_proxy_get_interface_type (WpProxy * self, guint32 * version)
 }
 
 /*!
+ * \brief Gets the `pw_proxy` wrapped by this proxy object
  * \ingroup wpproxy
  * \param self the proxy
  * \returns a pointer to the underlying `pw_proxy` object
diff --git a/lib/wp/session-item.c b/lib/wp/session-item.c
index 305f1951..63f13fa3 100644
--- a/lib/wp/session-item.c
+++ b/lib/wp/session-item.c
@@ -255,6 +255,8 @@ wp_session_item_reset (WpSessionItem * self)
 }
 
 /*!
+ * \brief Configures the session item with a set of properties
+ *
  * \ingroup wpsessionitem
  * \param self the session item
  * \param props (transfer full): the properties used to configure the item
@@ -271,6 +273,8 @@ wp_session_item_configure (WpSessionItem * self, WpProperties * props)
 }
 
 /*!
+ * \brief Checks if the session item is configured
+ *
  * \ingroup wpsessionitem
  * \param self the session item
  * \returns TRUE if the item is configured, FALSE otherwise
@@ -314,6 +318,8 @@ wp_session_item_get_associated_proxy (WpSessionItem * self, GType proxy_type)
 }
 
 /*!
+ * \brief Gets the bound id of a proxy associated with the session item
+ *
  * \ingroup wpsessionitem
  * \param self the session item
  * \param proxy_type a WpProxy subclass GType
@@ -366,6 +372,8 @@ wp_session_item_remove (WpSessionItem * self)
 }
 
 /*!
+ * \brief Gets the properties of a session item.
+ *
  * \ingroup wpsessionitem
  * \param self the session item
  * \returns (transfer full): the item's properties.
@@ -382,6 +390,8 @@ wp_session_item_get_properties (WpSessionItem * self)
 }
 
 /*!
+ * \brief Looks up a named session item property value for a given key.
+ *
  * \ingroup wpsessionitem
  * \param self the session item
  * \param key the property key
diff --git a/lib/wp/si-factory.c b/lib/wp/si-factory.c
index af4f6a71..bfcbc888 100644
--- a/lib/wp/si-factory.c
+++ b/lib/wp/si-factory.c
@@ -99,6 +99,8 @@ wp_si_factory_class_init (WpSiFactoryClass * klass)
 }
 
 /*!
+ * \brief Gets the name of the factory
+ *
  * \ingroup wpsifactory
  * \param self the factory
  * \returns the factory name
@@ -158,6 +160,8 @@ find_factory_func (gpointer factory, gpointer name_quark)
 }
 
 /*!
+ * \brief Looks up a factory matching a name
+ *
  * \ingroup wpsifactory
  * \param core the core
  * \param factory_name the lookup name
@@ -225,6 +229,8 @@ wp_simple_si_factory_class_init (WpSimpleSiFactoryClass * klass)
 }
 
 /*!
+ * \brief Creates a simple factory that constructs objects of a given GType.
+ *
  * \ingroup wpsifactory
  * \param factory_name the factory name; must be a static string!
  * \param si_type the WpSessionItem subclass type to instantiate for
diff --git a/lib/wp/si-interfaces.c b/lib/wp/si-interfaces.c
index 12010a0b..df219747 100644
--- a/lib/wp/si-interfaces.c
+++ b/lib/wp/si-interfaces.c
@@ -74,6 +74,8 @@ wp_si_endpoint_get_registration_info (WpSiEndpoint * self)
 }
 
 /*!
+ * \brief Gets the properties of the endpoint
+ *
  * \ingroup wpsiinterfaces
  * \param self the session item
  * \returns (transfer full) (nullable): the properties of the endpoint
@@ -100,6 +102,8 @@ wp_si_adapter_default_init (WpSiAdapterInterface * iface)
 }
 
 /**
+ * \brief Gets the format used to configure the adapter session item's ports
+ *
  * \ingroup wpsiinterfaces
  * \param self the session item
  * \param mode (out) (nullable): the mode
@@ -241,6 +245,8 @@ wp_si_linkable_get_ports (WpSiLinkable * self, const gchar * context)
 }
 
 /*!
+ * \brief Gets the acquisition interface associated with the item
+ *
  * \ingroup wpsiinterfaces
  * \param self the session item
  *
@@ -315,6 +321,8 @@ wp_si_link_get_registration_info (WpSiLink * self)
 }
 
 /*!
+ * \brief Gets the properties of the link
+ *
  * \ingroup wpsiinterfaces
  * \param self the session item
  * \returns (transfer full) (nullable): the properties of the link
@@ -329,6 +337,8 @@ wp_si_link_get_properties (WpSiLink * self)
 }
 
 /*!
+ * \brief Gets the output item linked by the link
+ *
  * \ingroup wpsiinterfaces
  * \param self the session item
  * \returns (transfer none): the output item that is linked by this link
@@ -343,6 +353,8 @@ wp_si_link_get_out_item (WpSiLink * self)
 }
 
 /*!
+ * \brief Gets the input item linked by the link
+ *
  * \ingroup wpsiinterfaces
  * \param self the session item
  * \returns (transfer none): the input item that is linked by this link
diff --git a/lib/wp/spa-pod.c b/lib/wp/spa-pod.c
index 07ac14bb..26aa0229 100644
--- a/lib/wp/spa-pod.c
+++ b/lib/wp/spa-pod.c
@@ -134,6 +134,7 @@ wp_spa_pod_builder_new (size_t size, WpSpaType type)
 }
 
 /*!
+ * \brief Increases the reference count of a spa pod object
  * \ingroup wpspapod
  * \param self a spa pod object
  * \returns (transfer full): \a self with an additional reference count on it
@@ -194,6 +195,8 @@ wp_spa_pod_new (const struct spa_pod *pod, WpSpaPodType type, guint32 flags)
 }
 
 /*!
+ * \brief Constructs a new WpSpaPod that wraps the given `spa_pod`.
+ *
  * \ingroup wpspapod
  * \param pod a spa_pod
  * \returns a new WpSpaPod that references the data in \a pod. \a pod is not
@@ -208,6 +211,8 @@ wp_spa_pod_new_wrap (struct spa_pod *pod)
 }
 
 /*!
+ * \brief Constructs a new immutable WpSpaPod that wraps the given `spa_pod`.
+ *
  * \ingroup wpspapod
  * \param pod a constant spa_pod
  * \returns a new WpSpaPod that references the data in \a pod. \a pod is not
@@ -1781,6 +1786,8 @@ wp_spa_pod_get_array_child (WpSpaPod *self)
 }
 
 /*!
+ * \brief Increases the reference count of a spa pod builder
+ *
  * \ingroup wpspapod
  * \param self a spa pod builder object
  * \returns (transfer full): \a self with an additional reference count on it
@@ -2287,6 +2294,7 @@ wp_spa_pod_builder_end (WpSpaPodBuilder *self)
 }
 
 /*!
+ * \brief Increases the reference count of a spa pod parser
  * \ingroup wpspapod
  * \param self a spa pod sparser object
  * \returns (transfer full): \a self with an additional reference count on it
diff --git a/lib/wp/spa-type.c b/lib/wp/spa-type.c
index a3213630..79c523b2 100644
--- a/lib/wp/spa-type.c
+++ b/lib/wp/spa-type.c
@@ -163,6 +163,8 @@ wp_spa_type_from_name (const gchar *name)
 }
 
 /*!
+ * \brief Gets the parent type of an SPA type
+ *
  * \ingroup wpspatype
  * \param type a type id
  * \returns (transfer none): the direct parent type of the given \a type; if the
@@ -177,6 +179,8 @@ wp_spa_type_parent (WpSpaType type)
 }
 
 /*!
+ * \brief Gets the name of an SPA type
+ *
  * \ingroup wpspatype
  * \param type a type id
  * \returns the complete name of the given \a type or NULL if \a type is invalid
@@ -189,6 +193,8 @@ wp_spa_type_name (WpSpaType type)
 }
 
 /*!
+ * \brief Checks if an SPA type is a fundamental type
+ *
  * \ingroup wpspatype
  * \param type a type id
  * \returns TRUE if the \a type has no parent, FALSE otherwise
@@ -201,6 +207,8 @@ wp_spa_type_is_fundamental (WpSpaType type)
 }
 
 /*!
+ * \brief Checks if an SPA type is an Id type
+ *
  * \ingroup wpspatype
  * \param type a type id
  * \returns TRUE if the \a type is a SPA_TYPE_Id, FALSE otherwise
@@ -213,6 +221,8 @@ wp_spa_type_is_id (WpSpaType type)
 }
 
 /*!
+ * \brief Checks if an SPA type is an Object type
+ *
  * \ingroup wpspatype
  * \param type a type id
  * \returns TRUE if the \a type is a SPA_TYPE_Object, FALSE otherwise
@@ -253,6 +263,8 @@ wp_spa_type_get_object_id_values_table (WpSpaType type)
 }
 
 /*!
+ * \brief Gets the values table of an SPA type
+ *
  * \ingroup wpspatype
  * \param type a type id
  * \returns the associated WpSpaIdTable that contains possible
@@ -386,6 +398,8 @@ wp_spa_id_table_new_iterator (WpSpaIdTable table)
 }
 
 /*!
+ * \brief Finds a value in an SPA Id table
+ *
  * \ingroup wpspatype
  * \param table the id table
  * \param value a numeric value that is contained in the table
@@ -406,6 +420,8 @@ wp_spa_id_table_find_value (WpSpaIdTable table, guint value)
 }
 
 /*!
+ * \brief Finds a named value in an SPA Id table
+ *
  * \ingroup wpspatype
  * \param table the id table
  * \param name the full name of a value that is contained in the table
@@ -426,6 +442,8 @@ wp_spa_id_table_find_value_from_name (WpSpaIdTable table, const gchar * name)
 }
 
 /*!
+ * \brief Finds a short named value in an SPA Id table
+ *
  * \ingroup wpspatype
  * \param table the id table
  * \param short_name the short name of a value that is contained in the table
@@ -528,6 +546,8 @@ wp_spa_id_value_from_number (const gchar * table_name, guint id)
 }
 
 /*!
+ * \brief Gets the numeric value of an id value
+ *
  * \ingroup wpspatype
  * \param id an id value
  * \returns the numeric representation of this id value
@@ -542,6 +562,8 @@ wp_spa_id_value_number (WpSpaIdValue id)
 }
 
 /*!
+ * \brief Gets the name of an id value
+ *
  * \ingroup wpspatype
  * \param id an id value
  * \returns the full name of this id value
@@ -556,6 +578,8 @@ wp_spa_id_value_name (WpSpaIdValue id)
 }
 
 /*!
+ * \brief Gets the short name of an id value
+ *
  * \ingroup wpspatype
  * \param id an id value
  * \returns the short name of this id value
diff --git a/lib/wp/spa-type.h b/lib/wp/spa-type.h
index c07a94c0..cfdd2b97 100644
--- a/lib/wp/spa-type.h
+++ b/lib/wp/spa-type.h
@@ -38,6 +38,10 @@ struct spa_type_info;
 WP_API
 GType wp_spa_type_get_type (void);
 
+/*!
+ * \brief Type id representing an invalid SPA type
+ * \ingroup wpspatype
+ */
 static const WpSpaType WP_SPA_TYPE_INVALID = 0xffffffff;
 
 WP_API
diff --git a/lib/wp/state.c b/lib/wp/state.c
index d4e16ecd..48a9520b 100644
--- a/lib/wp/state.c
+++ b/lib/wp/state.c
@@ -146,6 +146,7 @@ wp_state_class_init (WpStateClass * klass)
 }
 
 /*!
+ * \brief Constructs a new state object
  * \ingroup wpstate
  * \param name the state name
  * \returns (transfer full): the new WpState
@@ -160,6 +161,7 @@ wp_state_new (const gchar *name)
 }
 
 /*!
+ * \brief Gets the name of a state object
  * \ingroup wpstate
  * \param self the state
  * \returns the name of this state
@@ -173,6 +175,7 @@ wp_state_get_name (WpState *self)
 }
 
 /*!
+ * \brief Gets the location of a state object
  * \ingroup wpstate
  * \param self the state
  * \returns the location of this state
diff --git a/lib/wp/transition.c b/lib/wp/transition.c
index 0568ba59..97bd455f 100644
--- a/lib/wp/transition.c
+++ b/lib/wp/transition.c
@@ -335,6 +335,7 @@ wp_transition_set_data (WpTransition * self, gpointer data,
 }
 
 /*!
+ * \brief Checks if the transition completed.
  * \ingroup wptransition
  * \param self the transition
  * \returns TRUE if the transition has completed (with or without an error),
@@ -351,6 +352,7 @@ wp_transition_get_completed (WpTransition * self)
 }
 
 /*!
+ * \brief Checks if the transition completed with an error.
  * \ingroup wptransition
  * \param self the transition
  * \returns TRUE if the transition completed with an error, FALSE otherwise
diff --git a/lib/wp/wp.c b/lib/wp/wp.c
index 5d1d2f2f..0c1834db 100644
--- a/lib/wp/wp.c
+++ b/lib/wp/wp.c
@@ -17,11 +17,12 @@
  */
 
 /*!
- * \param flags: initialization flags
+ * \brief Initializes WirePlumber and PipeWire underneath.
  *
- * Initializes WirePlumber and PipeWire underneath.
  * \em flags can modify which parts are initialized, in cases where you want
  * to handle part of this initialization externally.
+ *
+ * \param flags initialization flags
  */
 void
 wp_init (WpInitFlags flags)
@@ -61,6 +62,7 @@ wp_init (WpInitFlags flags)
 }
 
 /*!
+ * \brief Gets the Wireplumber module directory
  * \returns The Wireplumber module directory
  */
 const gchar *
@@ -76,6 +78,7 @@ wp_get_module_dir (void)
 }
 
 /*!
+ * \brief Gets the Wireplumber configuration directory
  * \returns The Wireplumber configuration directory
  */
 const gchar *
@@ -91,6 +94,7 @@ wp_get_config_dir (void)
 }
 
 /*!
+ * \brief Gets the Wireplumber data directory
  * \returns The Wireplumber data directory
  */
 const gchar *