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

52
lib/wp/node.h
View File

@@ -18,13 +18,15 @@ G_BEGIN_DECLS
struct pw_impl_node;
/**
* WpNodeState:
* @WP_NODE_STATE_ERROR: error state
* @WP_NODE_STATE_CREATING: the node is being created
* @WP_NODE_STATE_SUSPENDED: the node is suspended, the device might be closed
* @WP_NODE_STATE_IDLE: the node is running but there is no active port
* @WP_NODE_STATE_RUNNING: the node is running
/*!
* @memberof WpNode
*
* @brief
* @arg WP_NODE_STATE_ERROR: error state
* @arg WP_NODE_STATE_CREATING: the node is being created
* @arg WP_NODE_STATE_SUSPENDED: the node is suspended, the device might be closed
* @arg WP_NODE_STATE_IDLE: the node is running but there is no active port
* @arg WP_NODE_STATE_RUNNING: the node is running
*/
typedef enum {
WP_NODE_STATE_ERROR = -1,
@@ -34,22 +36,31 @@ typedef enum {
WP_NODE_STATE_RUNNING = 3,
} WpNodeState;
/**
* WpNodeFeatures:
* @WP_NODE_FEATURE_PORTS: caches information about ports, enabling
/*!
* @memberof WpNode
*
* @brief
* @arg WP_NODE_FEATURE_PORTS: caches information about ports, enabling
* the use of wp_node_get_n_ports(), wp_node_lookup_port(),
* wp_node_new_ports_iterator() and related methods
*
* An extension of #WpProxyFeatures
* An extension of [WpProxyFeatures](@ref proxy_features_section)
*/
typedef enum { /*< flags >*/
WP_NODE_FEATURE_PORTS = (WP_PROXY_FEATURE_CUSTOM_START << 0),
} WpNodeFeatures;
/**
* WP_TYPE_NODE:
/*!
* @memberof WpNode
*
* @brief The [WpNode](@ref node_section)
* <a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType">
* GType</a>
*
* @code
* #define WP_TYPE_NODE (wp_node_get_type ())
* @endcode
*
* The #WpNode #GType
*/
#define WP_TYPE_NODE (wp_node_get_type ())
WP_API
@@ -91,10 +102,17 @@ WpPort * wp_node_lookup_port_full (WpNode * self, WpObjectInterest * interest);
WP_API
void wp_node_send_command (WpNode * self, const gchar *command);
/**
* WP_TYPE_IMPL_NODE:
/*!
* @memberof WpNode
*
* @brief The [WpImplNode](@ref impl_node_section)
* <a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType">
* GType</a>
*
* @code
* #define WP_TYPE_IMPL_NODE (wp_impl_node_get_type ())
* @endcode
*
* The #WpImplNode #GType
*/
#define WP_TYPE_IMPL_NODE (wp_impl_node_get_type ())
WP_API