Commit 54721da7 authored by Julian Bouzas's avatar Julian Bouzas

Fix doc warnings

parent 44a60b86
......@@ -133,7 +133,7 @@ wp_core_get_global (WpCore * self, GQuark key)
/**
* wp_core_foreach_global: (method)
* @self: the core
* @callback: the function to call for each global object
* @callback: (scope call): the function to call for each global object
* @user_data: data to passs to @callback
*
* Calls @callback for every global object registered
......
......@@ -292,8 +292,7 @@ wp_endpoint_class_init (WpEndpointClass * klass)
* Finishes the async construction of #WpEndpoint.
*/
WpEndpoint *
wp_endpoint_new_finish (GObject *initable, GAsyncResult *res,
GError **error)
wp_endpoint_new_finish (GObject *initable, GAsyncResult *res, GError **error)
{
GAsyncInitable *ai = G_ASYNC_INITABLE(initable);
return WP_ENDPOINT(g_async_initable_new_finish(ai, res, error));
......@@ -403,6 +402,14 @@ find_endpoints (GQuark key, gpointer global, gpointer user_data)
return WP_CORE_FOREACH_GLOBAL_CONTINUE;
}
/**
* wp_endpoint_find:
* @core: the core
* @media_class_lookup: the media class lookup string
*
* Returns: (element-type WpEndpoint) (transfer full): an array with all the
* endpoints matching the media class lookup string
*/
GPtrArray *
wp_endpoint_find (WpCore * core, const gchar * media_class_lookup)
{
......@@ -935,6 +942,14 @@ wp_endpoint_link_class_init (WpEndpointLinkClass * klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
}
/**
* wp_endpoint_link_get_source_endpoint:
* @self: the endpoint
*
* Gets the source endpoint of the link
*
* Returns: (transfer full): the source endpoint
*/
WpEndpoint *
wp_endpoint_link_get_source_endpoint (WpEndpointLink * self)
{
......@@ -957,6 +972,14 @@ wp_endpoint_link_get_source_stream (WpEndpointLink * self)
return priv->src_stream;
}
/**
* wp_endpoint_link_get_sink_endpoint:
* @self: the endpoint
*
* Gets the sink endpoint of the link
*
* Returns: (transfer full): the sink endpoint
*/
WpEndpoint *
wp_endpoint_link_get_sink_endpoint (WpEndpointLink * self)
{
......
......@@ -45,9 +45,16 @@ wp_factory_class_init (WpFactoryClass * klass)
object_class->finalize = wp_factory_finalize;
}
/**
* wp_factory_new:
* @core: the core
* @name: the name of the factory
* @func: the create object callback
*
* Returns: (transfer full): the newly created factory
*/
WpFactory *
wp_factory_new (WpCore * core, const gchar * name,
WpFactoryFunc func)
wp_factory_new (WpCore * core, const gchar * name, WpFactoryFunc func)
{
WpFactory *f = NULL;
......@@ -114,6 +121,13 @@ find_factory_func (GQuark key, gpointer global, gpointer user_data)
return WP_CORE_FOREACH_GLOBAL_DONE;
}
/**
* wp_factory_find:
* @core: the core
* @name: the lookup name
*
* Returns: (transfer none): the factory matching the lookup name
*/
WpFactory *
wp_factory_find (WpCore * core, const gchar * name)
{
......
......@@ -54,8 +54,8 @@ if get_option('introspection')
gnome.generate_gir(wp_lib,
namespace: 'Wp',
nsversion: wireplumber_api_version,
sources: [wp_lib_sources, wp_lib_headers],
includes: ['GLib-2.0', 'GObject-2.0'],
sources: [wp_lib_sources, wp_lib_headers, enums],
includes: ['GLib-2.0', 'GObject-2.0', 'Gio-2.0'],
install: true,
)
endif
......
......@@ -108,9 +108,19 @@ wp_module_load_c (WpModule * self, WpCore * core,
return TRUE;
}
/**
* wp_module_load:
* @core: the core
* @abi: the abi name of the module
* @module_name: the module name
* @args: the args passed to the module
* @error: return location for errors, or NULL to ignore
*
* Returns: (transfer full): the loaded module
*/
WpModule *
wp_module_load (WpCore * core, const gchar * abi,
const gchar * module_name, GVariant * args, GError ** error)
wp_module_load (WpCore * core, const gchar * abi, const gchar * module_name,
GVariant * args, GError ** error)
{
g_autoptr (WpModule) module = NULL;
......
......@@ -20,7 +20,7 @@ WpModule * wp_module_load (WpCore * core, const gchar * abi,
const gchar * module_name, GVariant * args, GError ** error);
GVariant * wp_module_get_properties (WpModule * module);
WpCore * wp_module_get_core (WpModule * module);
WpCore * wp_module_get_core (WpModule * self);
void wp_module_set_destroy_callback (WpModule * module, GDestroyNotify callback,
gpointer data);
......
......@@ -89,11 +89,11 @@ policy_mgr_endpoint_removed (WpCore *core, GQuark key, WpEndpoint *ep,
}
/**
* WpPolicyManager::wp_policy_manager_get_instance:
* wp_policy_manager_get_instance:
* @core: the #WpCore
*
* Returns: (transfer full): the instance of #WpPolicyManager that is
* registered on the @core
* registered on the @core
*/
WpPolicyManager *
wp_policy_manager_get_instance (WpCore *core)
......@@ -261,6 +261,13 @@ wp_policy_get_rank (WpPolicy *self)
return priv->rank;
}
/**
* wp_policy_get_core:
* @self: the policy
*
* Returns: (transfer full): the core of the policy
*/
WpCore *
wp_policy_get_core (WpPolicy *self)
{
......
......@@ -9,7 +9,7 @@
#include "remote-pipewire.h"
#include <pipewire/pipewire.h>
/**
/*
* Integration between the PipeWire main loop and GMainLoop
*/
......
......@@ -131,6 +131,12 @@ wp_remote_class_init (WpRemoteClass *klass)
0, NULL, NULL, NULL, G_TYPE_NONE, 1, WP_TYPE_REMOTE_STATE);
}
/**
* wp_remote_get_core:
* @self: the remote
*
* Returns: (transfer full): the core of the remote
*/
WpCore *
wp_remote_get_core (WpRemote *self)
{
......
......@@ -13,11 +13,20 @@
G_BEGIN_DECLS
/**
* WpRemoteState:
* @WP_REMOTE_STATE_ERROR: remote is in error
* @WP_REMOTE_STATE_UNCONNECTED: not connected
* @WP_REMOTE_STATE_CONNECTING: connecting to remote service
* @WP_REMOTE_STATE_CONNECTED: remote is connected and ready
*
* The different states the remote can be
*/
typedef enum {
WP_REMOTE_STATE_ERROR = -1, /**< remote is in error */
WP_REMOTE_STATE_UNCONNECTED = 0, /**< not connected */
WP_REMOTE_STATE_CONNECTING = 1, /**< connecting to remote service */
WP_REMOTE_STATE_CONNECTED = 2, /**< remote is connected and ready */
WP_REMOTE_STATE_ERROR = -1,
WP_REMOTE_STATE_UNCONNECTED = 0,
WP_REMOTE_STATE_CONNECTING = 1,
WP_REMOTE_STATE_CONNECTED = 2,
} WpRemoteState;
#define WP_TYPE_REMOTE (wp_remote_get_type ())
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment