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

lib/wp/global-proxy.c

@@ -6,11 +6,6 @@
  * SPDX-License-Identifier: MIT
  */
 
-/**
- * SECTION: global-proxy
- * @title: PipeWire Global Object Proxy
- */
-
 #define G_LOG_DOMAIN "wp-global-proxy"
 
 #include "global-proxy.h"
@@ -26,6 +21,34 @@ struct _WpGlobalProxyPrivate
   WpProperties *properties;
 };
 
+/*!
+ * @memberof WpGlobalProxy
+ *
+ * @props @b global
+ *
+ * @code
+ * “global” object *
+ * @endcode
+ *
+ * @brief Flags : Read / Write / Construct Only
+ *
+ * @props @b global-properties
+ *
+ * @code
+ * “global-properties” [WpProperties](@ref properties_section) *
+ * @endcode
+ *
+ * @brief Flags : Read
+ *
+ * @props @b permissions
+ *
+ * @code
+ * “permissions” <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#guint">guint</a>
+ * @endcode
+ *
+ * @brief Flags : Read
+ *
+ */
 enum {
   PROP_0,
   PROP_GLOBAL,
@@ -34,12 +57,19 @@ enum {
   PROP_PERMISSIONS,
 };
 
-/**
- * WpGlobalProxy:
- *
- * A proxy that represents a PipeWire global object, i.e. an object that is
- * made available through the PipeWire registry.
+/*!
+ * @file global-proxy.c
  */
+
+/*!
+ * @struct WpGlobalProxy
+ * @section global_proxy_section Global Proxy
+ *
+ * @brief A proxy that represents a PipeWire global object, i.e. an object that is
+ * made available through the PipeWire registry.
+ *
+ */
+
 G_DEFINE_TYPE_WITH_PRIVATE (WpGlobalProxy, wp_global_proxy, WP_TYPE_PROXY)
 
 static void
@@ -134,7 +164,7 @@ wp_global_proxy_activate_get_next_step (WpObject * object,
     WpObjectFeatures missing)
 {
   /* we only support BOUND, so this is the only
-     feature that can be in @missing */
+     feature that can be in @em missing */
   g_return_val_if_fail (missing == WP_PROXY_FEATURE_BOUND,
       WP_TRANSITION_STEP_ERROR);
 
@@ -285,17 +315,19 @@ wp_global_proxy_class_init (WpGlobalProxyClass * klass)
           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 }
 
-/**
- * wp_global_proxy_request_destroy:
- * @self: the pipewire global
+/*!
+ * @memberof WpGlobalProxy
+ * @param self: the pipewire global
  *
- * Requests the PipeWire server to destroy the object represented by this proxy.
+ * @brief Requests the PipeWire server to destroy the object represented by this proxy.
  * If the server allows it, the object will be destroyed and the
  * WpProxy::pw-proxy-destroyed signal will be emitted. If the server does
  * not allow it, nothing will happen.
  *
- * This is mostly useful for destroying #WpLink and #WpEndpointLink objects.
+ * This is mostly useful for destroying [WpLink](@ref link_section) and
+ * [WpEndpointLink](@ref endpoint_link_section) objects.
  */
+
 void
 wp_global_proxy_request_destroy (WpGlobalProxy * self)
 {
@@ -311,12 +343,13 @@ wp_global_proxy_request_destroy (WpGlobalProxy * self)
   }
 }
 
-/**
- * wp_global_proxy_get_permissions:
- * @self: the pipewire global
+/*!
+ * @memberof WpGlobalProxy
+ * @param self: the pipewire global
  *
- * Returns: the permissions that wireplumber has on this object
+ * @returns the permissions that wireplumber has on this object
  */
+
 guint32
 wp_global_proxy_get_permissions (WpGlobalProxy * self)
 {
@@ -328,13 +361,14 @@ wp_global_proxy_get_permissions (WpGlobalProxy * self)
   return priv->global ? priv->global->permissions : PW_PERM_ALL;
 }
 
-/**
- * wp_global_proxy_get_global_properties:
- * @self: the pipewire global
+/*!
+ * @memberof WpGlobalProxy
+ * @param self: the pipewire global
  *
- * Returns: (transfer full): the global (immutable) properties of this
+ * @returns (transfer full): the global (immutable) properties of this
  *   pipewire object
  */
+
 WpProperties *
 wp_global_proxy_get_global_properties (WpGlobalProxy * self)
 {
@@ -348,18 +382,19 @@ wp_global_proxy_get_global_properties (WpGlobalProxy * self)
   return NULL;
 }
 
-/**
- * wp_global_proxy_bind:
- * @self: the pipewire global
+/*!
+ * @memberof WpGlobalProxy
+ * @param self: the pipewire global
  *
- * Binds to the global and creates the underlying `pw_proxy`. This may only
+ * @brief Binds to the global and creates the underlying `pw_proxy`. This may only
  * be called if there is no `pw_proxy` associated with this object yet.
  *
  * This is mostly meant to be called internally. It will create the `pw_proxy`
  * and will activate the %WP_PROXY_FEATURE_BOUND feature.
  *
- * Returns: %TRUE on success, %FALSE if there is no global to bind to
+ * @returns %TRUE on success, %FALSE if there is no global to bind to
  */
+
 gboolean
 wp_global_proxy_bind (WpGlobalProxy * self)
 {
@@ -372,4 +407,4 @@ wp_global_proxy_bind (WpGlobalProxy * self)
   if (priv->global)
     wp_proxy_set_pw_proxy (WP_PROXY (self), wp_global_bind (priv->global));
   return !!priv->global;
-}
+}