[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Libosinfo] [libosinfo PATCH 12/20] Add "Since: 0.2.9" to the documentation



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 redhat com>
---
 osinfo/osinfo_media.c          |  2 ++
 osinfo/osinfo_os.c             |  6 ++++++
 osinfo/osinfo_os.h             |  1 +
 osinfo/osinfo_os_variant.c     | 13 +++++++++++++
 osinfo/osinfo_os_variantlist.c |  2 ++
 5 files changed, 24 insertions(+)

diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index ccfc704..42a8f37 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -1641,6 +1641,8 @@ void osinfo_media_set_os(OsinfoMedia *media, OsinfoOs *os)
  * Gets the variants of the associated operating system.
  *
  * Returns: (transfer full): the operating system variant, or NULL
+ *
+ * Since: 0.2.9
  */
 OsinfoOsVariantList *osinfo_media_get_os_variants(OsinfoMedia *media)
 {
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 61f2c69..7c69bfb 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -620,6 +620,8 @@ const gchar *osinfo_os_get_distro(OsinfoOs *os)
  * Use this to determine the release status of the @os.
  *
  * Returns: (type OsinfoReleaseStatus): release status of @os.
+ *
+ * Since: 0.2.9
  */
 int osinfo_os_get_release_status(OsinfoOs *os)
 {
@@ -744,6 +746,8 @@ void osinfo_os_add_image(OsinfoOs *os, OsinfoImage *image)
  * Gets all known variants of operating system @os.
  *
  * Returns: (transfer full): A list of variants
+ *
+ * Since: 0.2.9
  */
 OsinfoOsVariantList *osinfo_os_get_variant_list(OsinfoOs *os)
 {
@@ -762,6 +766,8 @@ OsinfoOsVariantList *osinfo_os_get_variant_list(OsinfoOs *os)
  * @variant: (transfer none): the variant to add
  *
  * Adds a variant @variant to operating system @os.
+ *
+ * Since: 0.2.9
  */
 void osinfo_os_add_variant(OsinfoOs *os, OsinfoOsVariant *variant)
 {
diff --git a/osinfo/osinfo_os.h b/osinfo/osinfo_os.h
index 6207a53..2bec1c8 100644
--- a/osinfo/osinfo_os.h
+++ b/osinfo/osinfo_os.h
@@ -86,6 +86,7 @@ struct _OsinfoOsClass
 
 /**
  * OsinfoReleaseStatus:
+ * Since: 0.2.9
  * @OSINFO_RELEASE_STATUS_RELEASED: A released OS.
  * @OSINFO_RELEASE_STATUS_SNAPSHOT: A continuous integration snapshot and not
  * an actual released product yet. For example, gnome-continuous images for
diff --git a/osinfo/osinfo_os_variant.c b/osinfo/osinfo_os_variant.c
index 3320209..a623146 100644
--- a/osinfo/osinfo_os_variant.c
+++ b/osinfo/osinfo_os_variant.c
@@ -125,6 +125,17 @@ osinfo_os_variant_init(OsinfoOsVariant *variant)
     variant->priv = OSINFO_OS_VARIANT_GET_PRIVATE(variant);
 }
 
+/**
+ * osinfo_os_variant_new:
+ *
+ * @id: the id of the os variant to be created
+ *
+ * Creates a new os variant
+ *
+ * Returns: (transfer full): An os variant entity
+ *
+ * Since: 0.2.9
+ */
 OsinfoOsVariant *osinfo_os_variant_new(const gchar *id)
 {
     OsinfoOsVariant *variant;
@@ -143,6 +154,8 @@ OsinfoOsVariant *osinfo_os_variant_new(const gchar *id)
  * The name of the @variant
  *
  * Returns: (transfer none): the name, or NULL
+ *
+ * Since: 0.2.9
  */
 const gchar *osinfo_os_variant_get_name(OsinfoOsVariant *variant)
 {
diff --git a/osinfo/osinfo_os_variantlist.c b/osinfo/osinfo_os_variantlist.c
index 4c8a249..73cfb9f 100644
--- a/osinfo/osinfo_os_variantlist.c
+++ b/osinfo/osinfo_os_variantlist.c
@@ -62,6 +62,8 @@ osinfo_os_variantlist_init(OsinfoOsVariantList *list)
  * Construct a new install_variant list that is initially empty.
  *
  * Returns: (transfer full): an empty install_variant list
+ *
+ * Since: 0.2.9
  */
 OsinfoOsVariantList *osinfo_os_variantlist_new(void)
 {
-- 
2.21.0


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]