colin/wireplumber
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

46
lib/wp/proxy.h
View File

@@ -15,10 +15,13 @@ G_BEGIN_DECLS
struct pw_proxy;
/**
* WpProxyFeatures:
/*!
* @memberof WpProxy
*
* Flags to be used as #WpObjectFeatures for #WpProxy subclasses.
* @section proxy_features_section WpProxyFeatures
*
* @brief Flags to be used as [WpObjectFeatures](@ref object_features_section) for
* [WpProxy](@ref proxy_section) subclasses.
*/
typedef enum { /*< flags >*/
/* standard features */
@@ -35,20 +38,22 @@ typedef enum { /*< flags >*/
WP_PROXY_FEATURE_CUSTOM_START = (1 << 16), /*< skip >*/
} WpProxyFeatures;
/**
/*!
* @memberof WpProxy
* WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL:
*
* The minimal feature set for proxies implementing #WpPipewireObject.
* This is a subset of #WP_PIPEWIRE_OBJECT_FEATURES_ALL
* @brief The minimal feature set for proxies implementing [WpPipewireObject](@ref pipewire_object_section).
* This is a subset of @em WP_PIPEWIRE_OBJECT_FEATURES_ALL
*/
static const WpObjectFeatures WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL =
(WP_PROXY_FEATURE_BOUND | WP_PIPEWIRE_OBJECT_FEATURE_INFO);
/**
/*!
* @memberof WpProxy
* WP_PIPEWIRE_OBJECT_FEATURES_ALL:
*
* The complete common feature set for proxies implementing #WpPipewireObject.
* This is a subset of #WP_OBJECT_FEATURES_ALL
* @brief The complete common feature set for proxies implementing [WpPipewireObject](@ref pipewire_object_section).
* This is a subset of @em WP_OBJECT_FEATURES_ALL
*/
static const WpObjectFeatures WP_PIPEWIRE_OBJECT_FEATURES_ALL =
(WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL |
@@ -58,20 +63,27 @@ static const WpObjectFeatures WP_PIPEWIRE_OBJECT_FEATURES_ALL =
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_PORT_CONFIG |
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_ROUTE);
/**
* WP_TYPE_PROXY:
/*!
* @memberof WpProxy
*
* @brief The [WpProxy](@ref proxy_section)
* <a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType">
* GType</a>
*
* @code
* #define WP_TYPE_PROXY (wp_proxy_get_type ())
* @endcode
*
* The #WpProxy #GType
*/
#define WP_TYPE_PROXY (wp_proxy_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpProxy, wp_proxy, WP, PROXY, WpObject)
/**
* WpProxyClass:
* @pw_iface_type: the PipeWire type of the interface that is being proxied by
* this class (ex. `PW_TYPE_INTERFACE_Node` for #WpNode)
* @pw_iface_version: the PipeWire version of the interface that is being
/*!
* @brief
* @em pw_iface_type: the PipeWire type of the interface that is being proxied by
* this class (ex. `PW_TYPE_INTERFACE_Node` for [WpNode](@ref node_section))
* @em pw_iface_version: the PipeWire version of the interface that is being
* proxied by this class
*/
struct _WpProxyClass