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

[Libosinfo] [libosinfo PATCH 19/20] Add "Since: 1.5.0" 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.

Signed-off-by: Fabiano Fidêncio <fidencio redhat com>
---
 osinfo/osinfo_image.c          | 6 ++++++
 osinfo/osinfo_install_config.c | 4 ++++
 osinfo/osinfo_product.c        | 2 ++
 osinfo/osinfo_tree.c           | 6 ++++++
 4 files changed, 18 insertions(+)

diff --git a/osinfo/osinfo_image.c b/osinfo/osinfo_image.c
index 05115a7..33fa58d 100644
--- a/osinfo/osinfo_image.c
+++ b/osinfo/osinfo_image.c
@@ -293,6 +293,8 @@ gboolean osinfo_image_get_cloud_init(OsinfoImage *image)
  * @image: an #OsinfoImage instance
  *
  * Returns: (transfer full): the operating system, or NULL
+ *
+ * Since: 1.5.0
  */
 OsinfoOs *osinfo_image_get_os(OsinfoImage *image)
 {
@@ -307,6 +309,8 @@ OsinfoOs *osinfo_image_get_os(OsinfoImage *image)
  * @os: an #OsinfoOs instance
  *
  * Sets the #OsinfoOs associated to the #OsinfoImage instance.
+ *
+ * Since: 1.5.0
  */
 void osinfo_image_set_os(OsinfoImage *image, OsinfoOs *os)
 {
@@ -324,6 +328,8 @@ void osinfo_image_set_os(OsinfoImage *image, OsinfoOs *os)
  * Gets the varriants of the associated operating system
  *
  * Returns: (transfer full): the operating system variants, or NULL
+ *
+ * Since: 1.5.0
  */
 OsinfoOsVariantList *osinfo_image_get_os_variants(OsinfoImage *image)
 {
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 3d072d9..caec643 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -963,6 +963,8 @@ gboolean osinfo_install_config_get_driver_signing(OsinfoInstallConfig *config)
  *
  * When performing a tree based installation the script will need the installation
  * URL to be set, whenever the installation is performed from a non canonical place.
+ *
+ * Since: 1.5.0
  */
 void osinfo_install_config_set_installation_url(OsinfoInstallConfig *config,
                                                 const gchar *url)
@@ -977,6 +979,8 @@ void osinfo_install_config_set_installation_url(OsinfoInstallConfig *config,
  * @config: the install config
  *
  * Returns the URL the script will use to perform the installation.
+ *
+ * Since: 1.5.0
  */
 const gchar *osinfo_install_config_get_installation_url(OsinfoInstallConfig *config)
 {
diff --git a/osinfo/osinfo_product.c b/osinfo/osinfo_product.c
index dbb7402..a767585 100644
--- a/osinfo/osinfo_product.c
+++ b/osinfo/osinfo_product.c
@@ -485,6 +485,8 @@ void osinfo_product_foreach_related(OsinfoProduct *product,
  * Retrieve all the short-ids associated with the product.
  *
  * Returns: (transfer container) (element-type utf8): the list of short-ids.
+ *
+ * Since: 1.5.0
  */
 GList *osinfo_product_get_short_id_list(OsinfoProduct *prod)
 {
diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index 98f2334..8a58dd9 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -961,6 +961,8 @@ gboolean osinfo_tree_has_treeinfo(OsinfoTree *tree)
  * @tree: an #OsinfoTree instance
  *
  * Returns: (transfer full): the operating system, or NULL
+ *
+ * Since: 1.5.0
  */
 OsinfoOs *osinfo_tree_get_os(OsinfoTree *tree)
 {
@@ -976,6 +978,8 @@ OsinfoOs *osinfo_tree_get_os(OsinfoTree *tree)
  * @os: an #OsinfoOs instance
  *
  * Sets the #OsinfoOs associated to the #OsinfoTree instance.
+ *
+ * Since: 1.5.0
  */
 void osinfo_tree_set_os(OsinfoTree *tree, OsinfoOs *os)
 {
@@ -993,6 +997,8 @@ void osinfo_tree_set_os(OsinfoTree *tree, OsinfoOs *os)
  * Gets the variants of the associated operating system.
  *
  * Returns: (transfer full): the operating system variant, or NULL
+ *
+ * Since: 1.5.0
  */
 OsinfoOsVariantList *osinfo_tree_get_os_variants(OsinfoTree *tree)
 {
-- 
2.21.0


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