Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio <fidencio@xxxxxxxxxx>
---
osinfo/osinfo_db.c | 2 ++
osinfo/osinfo_media.c | 10 +++++++++-
osinfo/osinfo_media.h | 1 +
3 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/osinfo/osinfo_db.c b/osinfo/osinfo_db.c
index a2fc8bc..b5cdb71 100644
--- a/osinfo/osinfo_db.c
+++ b/osinfo/osinfo_db.c
@@ -980,6 +980,8 @@ static void fill_tree(OsinfoDb *db, OsinfoTree *tree,
* properties will be set.
*
* Returns: TRUE if @tree was found in @db, FALSE otherwise
+ *
+ * Since: 1.6.0
*/
gboolean osinfo_db_identify_tree(OsinfoDb *db,
OsinfoTree *tree)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index ad21b78..cf624d2 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -777,6 +777,8 @@ OsinfoMedia *osinfo_media_create_from_location(const gchar *location,
* NOTE: Currently this only works for ISO images/devices.
*
* Returns: (transfer full): a new #OsinfoMedia , or NULL on error
+ *
+ * Since: 1.6.0
*/
OsinfoMedia *osinfo_media_create_from_location_with_flags(const gchar *location,
GCancellable *cancellable,
@@ -1349,6 +1351,8 @@ void osinfo_media_create_from_location_async(const gchar *location,
* #osinfo_media_create_from_location_async.
*
* Returns: (transfer full): a new #OsinfoMedia , or NULL on error
+ *
+ * Since: 1.6.0
*/
OsinfoMedia *osinfo_media_create_from_location_finish(GAsyncResult *res,
GError **error)
@@ -1365,7 +1369,9 @@ OsinfoMedia *osinfo_media_create_from_location_finish(GAsyncResult *res,
* @flags: An #OsinfoMediaDetectFlag, or 0.
* @user_data: The user data to pass to @callback, or %NULL
*
- * Asynchronous variant of #osinfo_media_create_from_location.
+ * Asynchronous variant of #osinfo_media_create_from_location_with_flags.
+ *
+ * Since: 1.6.0
*/
void osinfo_media_create_from_location_with_flags_async(const gchar *location,
gint priority,
@@ -1833,6 +1839,8 @@ OsinfoInstallScriptList *osinfo_media_get_install_script_list(OsinfoMedia *media
* @media: and #OsinfoMedia instance
*
* Returns: #TRUE if the @media is bootable. #FALSE otherwise.
+ *
+ * Since: 1.6.0
*/
gboolean osinfo_media_is_bootable(OsinfoMedia *media)
{
diff --git a/osinfo/osinfo_media.h b/osinfo/osinfo_media.h
index fda5243..8eeb0e2 100644
--- a/osinfo/osinfo_media.h
+++ b/osinfo/osinfo_media.h
@@ -60,6 +60,7 @@ typedef enum {
/**
* OsinfoMediaDetectFlags
+ * Since: 1.6.0
* OSINFO_MEDIA_DETECT_REQUIRE_BOOTABLE: Requires a media to be bootable.
*
* Flags used for detecting a media.
--
2.21.0
_______________________________________________
Libosinfo mailing list
Libosinfo@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libosinfo
