docs: api: Replace hotdoc specific commands with Doxygen specific commands

This commit is contained in:
Raghavendra
2021-05-13 17:54:58 +03:00
committed by George Kiagiadakis
parent 89549247f8
commit d692f06f0d
90 changed files with 4716 additions and 2766 deletions

View File

@@ -5,12 +5,9 @@
*
* SPDX-License-Identifier: MIT
*/
/**
* SECTION: proxy
* @title: PipeWire Object Proxy
/*!
* @file proxy.c
*/
#define G_LOG_DOMAIN "wp-proxy"
#include "proxy.h"
@@ -28,12 +25,82 @@ struct _WpProxyPrivate
struct spa_hook listener;
};
/*!
* @memberof WpProxy
*
* @props @b bound-id
*
* @code
* "bound-id" guint
* @endcode
*
* Flags : Read
*
* @props @b pw-proxy
*
* @code
* "pw-proxy" gpointer
* @endcode
*
* Flags : Read
*
*/
enum {
PROP_0,
PROP_BOUND_ID,
PROP_PW_PROXY,
};
/*!
* @memberof WpProxy
*
* @signal @b bound
*
* @code
* bound_callback (WpProxy * self,
* guint object,
* gpointer user_data)
* @endcode
*
* @b Parameters:
*
* @arg `self`
* @arg `object`
* @arg `user_data`
*
* Flags: Run First
*
* @signal @b pw-proxy-created
*
* @code
* pw_proxy_created_callback (WpProxy * self,
* gpointer object,
* gpointer user_data)
* @endcode
*
* @b Parameters:
*
* @arg `self`
* @arg `object`
* @arg `user_data`
*
* Flags: Run First
*
* @signal @b pw-proxy-destroyed
*
* @code
* pw_proxy_destroyed_callback (WpProxy * self,
* gpointer user_data)
* @endcode
*
* @b Parameters:
*
* @arg `self`
* @arg `user_data`
*
* Flags: Run First
*
*/
enum
{
SIGNAL_PW_PROXY_CREATED,
@@ -45,15 +112,18 @@ enum
static guint signals[LAST_SIGNAL] = { 0 };
/**
* WpProxy:
/*!
* @struct WpProxy
* @section proxy_section Pipewire Object Proxy
*
* Base class for all objects that expose PipeWire objects using `pw_proxy`
* @brief Base class for all objects that expose PipeWire objects using `pw_proxy`
* underneath.
*
* This base class cannot be instantiated. It provides handling of
* pw_proxy's events and exposes common functionality.
*
*/
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (WpProxy, wp_proxy, WP_TYPE_OBJECT)
static void
@@ -184,16 +254,17 @@ wp_proxy_class_init (WpProxyClass * klass)
G_TYPE_NONE, 3, G_TYPE_INT, G_TYPE_INT, G_TYPE_STRING);
}
/**
* wp_proxy_get_bound_id:
* @self: the proxy
/*!
* @memberof WpProxy
* @param self: the proxy
*
* Returns the bound id, which is the id that this object has on the
* @brief Returns the bound id, which is the id that this object has on the
* pipewire registry (a.k.a. the global id). The object must have the
* %WP_PROXY_FEATURE_BOUND feature before this method can be called.
*
* Returns: the bound id of this object
* @returns the bound id of this object
*/
guint32
wp_proxy_get_bound_id (WpProxy * self)
{
@@ -205,13 +276,14 @@ wp_proxy_get_bound_id (WpProxy * self)
return priv->pw_proxy ? pw_proxy_get_bound_id (priv->pw_proxy) : SPA_ID_INVALID;
}
/**
* wp_proxy_get_interface_type:
* @self: the proxy
* @version: (out) (optional): the version of the interface
/*!
* @memberof WpProxy
* @param self: the proxy
* @param version: (out) (optional): the version of the interface
*
* Returns: the PipeWire type of the interface that is being proxied
* @returns the PipeWire type of the interface that is being proxied
*/
const gchar *
wp_proxy_get_interface_type (WpProxy * self, guint32 * version)
{
@@ -228,11 +300,13 @@ wp_proxy_get_interface_type (WpProxy * self, guint32 * version)
}
}
/**
* wp_proxy_get_pw_proxy:
/*!
* @memberof WpProxy
*
* Returns: a pointer to the underlying `pw_proxy` object
* @param self: the proxy
* @returns a pointer to the underlying `pw_proxy` object
*/
struct pw_proxy *
wp_proxy_get_pw_proxy (WpProxy * self)
{
@@ -242,13 +316,14 @@ wp_proxy_get_pw_proxy (WpProxy * self)
return priv->pw_proxy;
}
/**
* wp_proxy_set_pw_proxy:
/*!
* @memberof WpProxy
*
* Private method to be used by subclasses to set the `pw_proxy` pointer
* @brief Private method to be used by subclasses to set the `pw_proxy` pointer
* when it is available. This can be called only if there is no `pw_proxy`
* already set. Takes ownership of @proxy.
* already set. Takes ownership of @em proxy.
*/
void
wp_proxy_set_pw_proxy (WpProxy * self, struct pw_proxy * proxy)
{