The effect of the \deprecated tag is (for a reason unknown to me) that
all documentation for the tagged entity is removed. That's not nice,
so this patch replaces the tag with plain text "Deprecated" with bold
formatting.
---
src/pulse/def.h | 4 ++--
src/pulse/introspect.h | 28 ++++++++++++++--------------
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/src/pulse/def.h b/src/pulse/def.h
index 58190cb..ae3719f 100644
--- a/src/pulse/def.h
+++ b/src/pulse/def.h
@@ -515,7 +515,7 @@ typedef enum pa_subscription_mask {
/** \cond fulldocs */
PA_SUBSCRIPTION_MASK_AUTOLOAD = 0x0100U,
- /**< \deprecated Autoload table events. */
+ /**< \b Deprecated. Autoload table events. */
/** \endcond */
PA_SUBSCRIPTION_MASK_CARD = 0x0200U,
@@ -553,7 +553,7 @@ typedef enum pa_subscription_event_type {
/** \cond fulldocs */
PA_SUBSCRIPTION_EVENT_AUTOLOAD = 0x0008U,
- /**< \deprecated Event type: Autoload table changes. */
+ /**< \b Deprecated. Event type: Autoload table changes. */
/** \endcond */
PA_SUBSCRIPTION_EVENT_CARD = 0x0009U,
diff --git a/src/pulse/introspect.h b/src/pulse/introspect.h
index 023b418..5193c0c 100644
--- a/src/pulse/introspect.h
+++ b/src/pulse/introspect.h
@@ -389,7 +389,7 @@ typedef struct pa_module_info {
*argument; /**< Argument string of the module */
uint32_t n_used; /**< Usage counter or PA_INVALID_INDEX */
/** \cond fulldocs */
- int auto_unload; /**< \deprecated Non-zero if this is an autoloaded module. */
+ int auto_unload; /**< \b Deprecated. Non-zero if this is an autoloaded module. */
/** \endcond */
pa_proplist *proplist; /**< Property list \since 0.9.15 */
} pa_module_info;
@@ -443,7 +443,7 @@ pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_suc
/** @{ \name Cards */
-/** \deprecated Superseded by pa_card_profile_info2 \since 0.9.15 */
+/** \b Deprecated. Superseded by pa_card_profile_info2 \since 0.9.15 */
typedef struct pa_card_profile_info {
const char *name; /**< Name of this profile */
const char *description; /**< Description of this profile */
@@ -479,7 +479,7 @@ typedef struct pa_card_port_info {
int available; /**< A #pa_port_available enum, indicating availability status of this port. */
int direction; /**< A #pa_direction enum, indicating the direction of this port. */
uint32_t n_profiles; /**< Number of entries in profile array */
- pa_card_profile_info** profiles; /**< \deprecated Superseded by profiles2 */
+ pa_card_profile_info** profiles; /**< \b Deprecated. Superseded by profiles2 */
pa_proplist *proplist; /**< Property list */
int64_t latency_offset; /**< Latency offset of the port that gets added to the sink/source latency when the port is active. \since 3.0 */
pa_card_profile_info2** profiles2; /**< Array of pointers to available profiles, or NULL. Array is terminated by an entry set to NULL. */
@@ -494,8 +494,8 @@ typedef struct pa_card_info {
uint32_t owner_module; /**< Index of the owning module, or PA_INVALID_INDEX. */
const char *driver; /**< Driver name */
uint32_t n_profiles; /**< Number of entries in profile array */
- pa_card_profile_info* profiles; /**< \deprecated Superseded by profiles2 */
- pa_card_profile_info* active_profile; /**< \deprecated Superseded by active_profile2 */
+ pa_card_profile_info* profiles; /**< \b Deprecated. Superseded by profiles2 */
+ pa_card_profile_info* active_profile; /**< \b Deprecated. Superseded by active_profile2 */
pa_proplist *proplist; /**< Property list */
uint32_t n_ports; /**< Number of entries in port array */
pa_card_port_info **ports; /**< Array of pointers to ports, or NULL. Array is terminated by an entry set to NULL. */
@@ -687,13 +687,13 @@ pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t
/** @{ \name Autoload Entries */
-/** \deprecated Type of an autoload entry. */
+/** \b Deprecated. Type of an autoload entry. */
typedef enum pa_autoload_type {
PA_AUTOLOAD_SINK = 0,
PA_AUTOLOAD_SOURCE = 1
} pa_autoload_type_t;
-/** \deprecated Stores information about autoload entries. Please note that this structure
+/** \b Deprecated. Stores information about autoload entries. Please note that this structure
* can be extended as part of evolutionary API updates at any time in
* any new release. */
typedef struct pa_autoload_info {
@@ -704,25 +704,25 @@ typedef struct pa_autoload_info {
const char *argument; /**< Argument string for module */
} pa_autoload_info;
-/** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and friends */
+/** \b Deprecated. Callback prototype for pa_context_get_autoload_info_by_name() and friends */
typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
-/** \deprecated Get info about a specific autoload entry. */
+/** \b Deprecated. Get info about a specific autoload entry. */
pa_operation* pa_context_get_autoload_info_by_name(pa_context *c, const char *name, pa_autoload_type_t type, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
-/** \deprecated Get info about a specific autoload entry. */
+/** \b Deprecated. Get info about a specific autoload entry. */
pa_operation* pa_context_get_autoload_info_by_index(pa_context *c, uint32_t idx, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
-/** \deprecated Get the complete list of autoload entries. */
+/** \b Deprecated. Get the complete list of autoload entries. */
pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
-/** \deprecated Add a new autoload entry. */
+/** \b Deprecated. Add a new autoload entry. */
pa_operation* pa_context_add_autoload(pa_context *c, const char *name, pa_autoload_type_t type, const char *module, const char*argument, pa_context_index_cb_t, void* userdata) PA_GCC_DEPRECATED;
-/** \deprecated Remove an autoload entry. */
+/** \b Deprecated. Remove an autoload entry. */
pa_operation* pa_context_remove_autoload_by_name(pa_context *c, const char *name, pa_autoload_type_t type, pa_context_success_cb_t cb, void* userdata) PA_GCC_DEPRECATED;
-/** \deprecated Remove an autoload entry. */
+/** \b Deprecated. Remove an autoload entry. */
pa_operation* pa_context_remove_autoload_by_index(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void* userdata) PA_GCC_DEPRECATED;
/** @} */
--
1.8.3.1
