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,17 +5,18 @@
*
* SPDX-License-Identifier: MIT
*/
/**
* SECTION: port
* @title: PipeWire Port
/*!
* @file port.c
*/
#define G_LOG_DOMAIN "wp-port"
#include "port.h"
#include "private/pipewire-object-mixin.h"
/*!
* @brief
* @em parent
*/
struct _WpPort
{
WpGlobalProxy parent;
@@ -24,15 +25,19 @@ struct _WpPort
static void wp_port_pw_object_mixin_priv_interface_init (
WpPwObjectMixinPrivInterface * iface);
/**
* WpPort:
/*!
* @struct WpPort
* @section port_section Port
*
* The #WpPort class allows accessing the properties and methods of a
* PipeWire port object (`struct pw_port`).
* @brief The [WpPort](@ref port_section) class allows accessing the properties
* and methods of a PipeWire port object (`struct pw_port`).
*
* A [WpPort](@ref port_section) is constructed internally when a new port appears
* on the PipeWire registry and it is made available through the
* [WpObjectManager](@ref object_manager_section) API.
*
* A #WpPort is constructed internally when a new port appears on the
* PipeWire registry and it is made available through the #WpObjectManager API.
*/
G_DEFINE_TYPE_WITH_CODE (WpPort, wp_port, WP_TYPE_GLOBAL_PROXY,
G_IMPLEMENT_INTERFACE (WP_TYPE_PIPEWIRE_OBJECT,
wp_pw_object_mixin_object_interface_init)
@@ -136,6 +141,13 @@ wp_port_pw_object_mixin_priv_interface_init (
iface->enum_params = wp_port_enum_params;
}
/*!
* @memberof WpPort
* @param self: the port
*
* @returns the current direction of the port
*/
WpDirection
wp_port_get_direction (WpPort * self)
{
@@ -147,4 +159,4 @@ wp_port_get_direction (WpPort * self)
const struct pw_port_info *info = d->info;
return (WpDirection) info->direction;
}
}