docs: Add missing '\since' attributes to types and functions that have been added in versions later than 0.4.0

This commit is contained in:
Tom A. Wagner
2023-08-30 11:20:06 +02:00
parent 3a4b91fad7
commit 6e81dc7a66
7 changed files with 27 additions and 0 deletions

View File

@@ -515,6 +515,8 @@ wp_core_get_pw_core (WpCore * self)
* \returns (transfer full) (nullable): a comma separated string with all the * \returns (transfer full) (nullable): a comma separated string with all the
* virtual machine types that this core matches, or NULL if the core is not * virtual machine types that this core matches, or NULL if the core is not
* running in a virtual machine. * running in a virtual machine.
*
* \since 0.4.11
*/ */
gchar * gchar *
wp_core_get_vm_type (WpCore *self) wp_core_get_vm_type (WpCore *self)

View File

@@ -24,6 +24,9 @@ enum
PROP_DBUS_STATE, PROP_DBUS_STATE,
}; };
/**
* \since 0.4.11
*/
struct _WpDbus struct _WpDbus
{ {
WpObject parent; WpObject parent;

View File

@@ -18,6 +18,8 @@ G_BEGIN_DECLS
/*! /*!
* \brief Flags to be used as WpObjectFeatures for WpDbus. * \brief Flags to be used as WpObjectFeatures for WpDbus.
* \ingroup wpdbus * \ingroup wpdbus
*
* \since 0.4.11
*/ */
typedef enum { /*< flags >*/ typedef enum { /*< flags >*/
/* main features */ /* main features */
@@ -27,6 +29,8 @@ typedef enum { /*< flags >*/
/*! /*!
* \brief The state of the dbus connection * \brief The state of the dbus connection
* \ingroup wpdbus * \ingroup wpdbus
*
* \since 0.4.11
*/ */
typedef enum { typedef enum {
WP_DBUS_STATE_CLOSED = 0, WP_DBUS_STATE_CLOSED = 0,

View File

@@ -24,6 +24,8 @@
* constructed factory objects are reported in by PipeWire registry * constructed factory objects are reported in by PipeWire registry
* and it is made available for wireplumber clients through the * and it is made available for wireplumber clients through the
* WpObjectManager API. * WpObjectManager API.
*
* \since 0.4.5
*/ */
struct _WpFactory struct _WpFactory

View File

@@ -16,6 +16,8 @@ G_BEGIN_DECLS
/*! /*!
* \brief The state of the link * \brief The state of the link
* \ingroup wplink * \ingroup wplink
*
* \since 0.4.11
*/ */
typedef enum { typedef enum {
WP_LINK_STATE_ERROR = -2, /*!< the link is in error */ WP_LINK_STATE_ERROR = -2, /*!< the link is in error */
@@ -30,6 +32,8 @@ typedef enum {
/*! /*!
* \brief An extension of WpProxyFeatures * \brief An extension of WpProxyFeatures
* \ingroup wplink * \ingroup wplink
*
* \since 0.4.11
*/ */
typedef enum { /*< flags >*/ typedef enum { /*< flags >*/
/*! waits until the state of the link is >= PAUSED */ /*! waits until the state of the link is >= PAUSED */

View File

@@ -19,12 +19,18 @@
/*! \defgroup wpspajson WpSpaJson */ /*! \defgroup wpspajson WpSpaJson */
/*! /*!
* \struct WpSpaJson * \struct WpSpaJson
*
* \since 0.4.8
*/ */
/*! /*!
* \struct WpSpaJsonBuilder * \struct WpSpaJsonBuilder
*
* \since 0.4.8
*/ */
/*! /*!
* \struct WpSpaJsonParser * \struct WpSpaJsonParser
*
* \since 0.4.8
*/ */
static void static void
@@ -194,6 +200,8 @@ wp_spa_json_new_from_string (const gchar *json_str)
* \param len the specific length of the string * \param len the specific length of the string
* \returns a new WpSpaJson that references the data in \a json_str. \a json_str * \returns a new WpSpaJson that references the data in \a json_str. \a json_str
* is not copied, so it needs to stay alive. * is not copied, so it needs to stay alive.
*
* \since 0.4.10
*/ */
WpSpaJson * WpSpaJson *
wp_spa_json_new_from_stringn (const gchar *json_str, size_t len) wp_spa_json_new_from_stringn (const gchar *json_str, size_t len)

View File

@@ -70,6 +70,8 @@ wp_init (WpInitFlags flags)
/*! /*!
* \brief Gets the WirePlumber library version * \brief Gets the WirePlumber library version
* \returns WirePlumber library version * \returns WirePlumber library version
*
* \since 0.4.12
*/ */
const char * const char *
wp_get_library_version (void) wp_get_library_version (void)
@@ -80,6 +82,8 @@ wp_get_library_version (void)
/*! /*!
* \brief Gets the WirePlumber library API version * \brief Gets the WirePlumber library API version
* \returns WirePlumber library API version * \returns WirePlumber library API version
*
* \since 0.4.12
*/ */
const char * const char *
wp_get_library_api_version (void) wp_get_library_api_version (void)