From 6e81dc7a6670bc0e3c3beee83072c43d9ac98cd0 Mon Sep 17 00:00:00 2001 From: "Tom A. Wagner" Date: Wed, 30 Aug 2023 11:20:06 +0200 Subject: [PATCH] docs: Add missing '\since' attributes to types and functions that have been added in versions later than 0.4.0 --- lib/wp/core.c | 2 ++ lib/wp/dbus.c | 3 +++ lib/wp/dbus.h | 4 ++++ lib/wp/factory.c | 2 ++ lib/wp/link.h | 4 ++++ lib/wp/spa-json.c | 8 ++++++++ lib/wp/wp.c | 4 ++++ 7 files changed, 27 insertions(+) diff --git a/lib/wp/core.c b/lib/wp/core.c index 17b5edf8..5429f2ed 100644 --- a/lib/wp/core.c +++ b/lib/wp/core.c @@ -515,6 +515,8 @@ wp_core_get_pw_core (WpCore * self) * \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 * running in a virtual machine. + * + * \since 0.4.11 */ gchar * wp_core_get_vm_type (WpCore *self) diff --git a/lib/wp/dbus.c b/lib/wp/dbus.c index 7c2d023c..4113947b 100644 --- a/lib/wp/dbus.c +++ b/lib/wp/dbus.c @@ -24,6 +24,9 @@ enum PROP_DBUS_STATE, }; +/** + * \since 0.4.11 + */ struct _WpDbus { WpObject parent; diff --git a/lib/wp/dbus.h b/lib/wp/dbus.h index b67aac32..7075b626 100644 --- a/lib/wp/dbus.h +++ b/lib/wp/dbus.h @@ -18,6 +18,8 @@ G_BEGIN_DECLS /*! * \brief Flags to be used as WpObjectFeatures for WpDbus. * \ingroup wpdbus + * + * \since 0.4.11 */ typedef enum { /*< flags >*/ /* main features */ @@ -27,6 +29,8 @@ typedef enum { /*< flags >*/ /*! * \brief The state of the dbus connection * \ingroup wpdbus + * + * \since 0.4.11 */ typedef enum { WP_DBUS_STATE_CLOSED = 0, diff --git a/lib/wp/factory.c b/lib/wp/factory.c index 0e041997..ae4b0e85 100644 --- a/lib/wp/factory.c +++ b/lib/wp/factory.c @@ -24,6 +24,8 @@ * constructed factory objects are reported in by PipeWire registry * and it is made available for wireplumber clients through the * WpObjectManager API. + * + * \since 0.4.5 */ struct _WpFactory diff --git a/lib/wp/link.h b/lib/wp/link.h index 77cc9c76..916a1917 100644 --- a/lib/wp/link.h +++ b/lib/wp/link.h @@ -16,6 +16,8 @@ G_BEGIN_DECLS /*! * \brief The state of the link * \ingroup wplink + * + * \since 0.4.11 */ typedef enum { WP_LINK_STATE_ERROR = -2, /*!< the link is in error */ @@ -30,6 +32,8 @@ typedef enum { /*! * \brief An extension of WpProxyFeatures * \ingroup wplink + * + * \since 0.4.11 */ typedef enum { /*< flags >*/ /*! waits until the state of the link is >= PAUSED */ diff --git a/lib/wp/spa-json.c b/lib/wp/spa-json.c index 1bbab339..bd5a0b69 100644 --- a/lib/wp/spa-json.c +++ b/lib/wp/spa-json.c @@ -19,12 +19,18 @@ /*! \defgroup wpspajson WpSpaJson */ /*! * \struct WpSpaJson + * + * \since 0.4.8 */ /*! * \struct WpSpaJsonBuilder + * + * \since 0.4.8 */ /*! * \struct WpSpaJsonParser + * + * \since 0.4.8 */ static void @@ -194,6 +200,8 @@ wp_spa_json_new_from_string (const gchar *json_str) * \param len the specific length of the string * \returns a new WpSpaJson that references the data in \a json_str. \a json_str * is not copied, so it needs to stay alive. + * + * \since 0.4.10 */ WpSpaJson * wp_spa_json_new_from_stringn (const gchar *json_str, size_t len) diff --git a/lib/wp/wp.c b/lib/wp/wp.c index b13858d9..616072ba 100644 --- a/lib/wp/wp.c +++ b/lib/wp/wp.c @@ -70,6 +70,8 @@ wp_init (WpInitFlags flags) /*! * \brief Gets the WirePlumber library version * \returns WirePlumber library version + * + * \since 0.4.12 */ const char * wp_get_library_version (void) @@ -80,6 +82,8 @@ wp_get_library_version (void) /*! * \brief Gets the WirePlumber library API version * \returns WirePlumber library API version + * + * \since 0.4.12 */ const char * wp_get_library_api_version (void)