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

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

Together with this change, documentation has been added to the functions
missing them.

Signed-off-by: Fabiano Fidêncio <fidencio redhat com>
---
 osinfo/osinfo_tree.c     | 43 ++++++++++++++++++++++++++++++++++++++++
 osinfo/osinfo_treelist.c | 14 +++++++++++++
 2 files changed, 57 insertions(+)

diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index b797cb4..f804e46 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -67,6 +67,15 @@ static void create_from_location_data_free(CreateFromLocationData *data)
     g_slice_free(CreateFromLocationData, data);
 }
 
+/**
+ * osinfo_tree_error_quark:
+ *
+ * Gets a #GQuark representing the string "osinfo-tree-error"
+ *
+ * Returns: the #GQuark representing the string.
+ *
+ * Since: 0.1.0
+ */
 GQuark
 osinfo_tree_error_quark(void)
 {
@@ -425,6 +434,18 @@ osinfo_tree_init(OsinfoTree *tree)
     g_weak_ref_init(&tree->priv->os, NULL);
 }
 
+/**
+ * osinfo_tree_new:
+ *
+ * @id: the id of the tree to be created
+ * @architecture: the architecture of the tree to be created
+ *
+ * Create a new tree entity
+ *
+ * Returns: (trasfer full): A tree entity
+ *
+ * Since: 0.1.0
+ */
 OsinfoTree *osinfo_tree_new(const gchar *id,
                             const gchar *architecture)
 {
@@ -464,6 +485,8 @@ static void on_tree_create_from_location_ready(GObject *source_object,
  * NOTE: Currently this only works for trees with a .treeinfo file
  *
  * Returns: (transfer full): a new #OsinfoTree , or NULL on error
+ *
+ * Since: 0.1.0
  */
 OsinfoTree *osinfo_tree_create_from_location(const gchar *location,
                                              GCancellable *cancellable,
@@ -713,6 +736,8 @@ osinfo_tree_create_from_location_async_helper(CreateFromLocationAsyncData *data,
  * @user_data: The user data to pass to @callback, or %NULL
  *
  * Asynchronous variant of #osinfo_tree_create_from_location.
+ *
+ * Since: 0.1.0
  */
 void osinfo_tree_create_from_location_async(const gchar *location,
                                             gint priority,
@@ -744,6 +769,8 @@ void osinfo_tree_create_from_location_async(const gchar *location,
  * #osinfo_tree_create_from_location_async.
  *
  * Returns: (transfer full): a new #OsinfoTree , or NULL on error
+ *
+ * Since: 0.1.0
  */
 OsinfoTree *osinfo_tree_create_from_location_finish(GAsyncResult *res,
                                                     GError **error)
@@ -762,6 +789,8 @@ OsinfoTree *osinfo_tree_create_from_location_finish(GAsyncResult *res,
  * Retrieves the target hardware architecture of the OS @tree provides.
  *
  * Returns: (transfer none): the hardware architecture, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_architecture(OsinfoTree *tree)
 {
@@ -793,6 +822,8 @@ const gchar *osinfo_tree_get_url(OsinfoTree *tree)
  * but rather a regular expression that matches it.
  *
  * Returns: (transfer none): the treeinfo family, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_treeinfo_family(OsinfoTree *tree)
 {
@@ -810,6 +841,8 @@ const gchar *osinfo_tree_get_treeinfo_family(OsinfoTree *tree)
  * architecture but rather a regular expression that matches it.
  *
  * Returns: (transfer none): the treeinfo architecture, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_treeinfo_arch(OsinfoTree *tree)
 {
@@ -827,6 +860,8 @@ const gchar *osinfo_tree_get_treeinfo_arch(OsinfoTree *tree)
  * but rather a regular expression that matches it.
  *
  * Returns: (transfer none): the treeinfo variant, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_treeinfo_variant(OsinfoTree *tree)
 {
@@ -844,6 +879,8 @@ const gchar *osinfo_tree_get_treeinfo_variant(OsinfoTree *tree)
  * rather a regular expression that matches it.
  *
  * Returns: (transfer none): the treeinfo version, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_treeinfo_version(OsinfoTree *tree)
 {
@@ -858,6 +895,8 @@ const gchar *osinfo_tree_get_treeinfo_version(OsinfoTree *tree)
  * Retrieves the path to the boot_iso image in the install tree.
  *
  * Returns: (transfer none): the path to boot_iso image, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_boot_iso_path(OsinfoTree *tree)
 {
@@ -874,6 +913,8 @@ const gchar *osinfo_tree_get_boot_iso_path(OsinfoTree *tree)
  * Note: This only applies to installer trees of 'linux' OS family.
  *
  * Returns: (transfer none): the path to kernel image, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_kernel_path(OsinfoTree *tree)
 {
@@ -890,6 +931,8 @@ const gchar *osinfo_tree_get_kernel_path(OsinfoTree *tree)
  * Note: This only applies to installer trees of 'linux' OS family.
  *
  * Returns: (transfer none): the path to initrd image, or NULL
+ *
+ * Since: 0.1.0
  */
 const gchar *osinfo_tree_get_initrd_path(OsinfoTree *tree)
 {
diff --git a/osinfo/osinfo_treelist.c b/osinfo/osinfo_treelist.c
index 9703929..0c79c2f 100644
--- a/osinfo/osinfo_treelist.c
+++ b/osinfo/osinfo_treelist.c
@@ -74,6 +74,8 @@ osinfo_treelist_init(OsinfoTreeList *list)
  * Construct a new tree list that is initially empty.
  *
  * Returns: (transfer full): an empty tree list
+ *
+ * Since: 0.1.0
  */
 OsinfoTreeList *osinfo_treelist_new(void)
 {
@@ -90,6 +92,9 @@ OsinfoTreeList *osinfo_treelist_new(void)
  * from @source
  *
  * Returns: (transfer full): a copy of the tree list
+ *
+ * Since: 0.1.0
+ *
  * Deprecated: 0.2.2: Use osinfo_list_new_copy() instead.
  */
 OsinfoTreeList *osinfo_treelist_new_copy(OsinfoTreeList *source)
@@ -109,6 +114,9 @@ OsinfoTreeList *osinfo_treelist_new_copy(OsinfoTreeList *source)
  * from @source that match @filter
  *
  * Returns: (transfer full): a filtered copy of the tree list
+ *
+ * Since: 0.1.0
+ *
  * Deprecated: 0.2.2: Use osinfo_list_new_filtered() instead.
  */
 OsinfoTreeList *osinfo_treelist_new_filtered(OsinfoTreeList *source,
@@ -130,6 +138,9 @@ OsinfoTreeList *osinfo_treelist_new_filtered(OsinfoTreeList *source,
  * trees that are present in both @sourceOne and @sourceTwo.
  *
  * Returns: (transfer full): an intersection of the two tree lists
+ *
+ * Since: 0.1.0
+ *
  * Deprecated: 0.2.2: Use osinfo_list_new_intersection() instead.
  */
 OsinfoTreeList *osinfo_treelist_new_intersection(OsinfoTreeList *sourceOne,
@@ -151,6 +162,9 @@ OsinfoTreeList *osinfo_treelist_new_intersection(OsinfoTreeList *sourceOne,
  * trees that are present in either @sourceOne and @sourceTwo.
  *
  * Returns: (transfer full): a union of the two tree lists
+ *
+ * Since: 0.1.0
+ *
  * Deprecated: 0.2.2: Use osinfo_list_new_union() instead.
  */
 OsinfoTreeList *osinfo_treelist_new_union(OsinfoTreeList *sourceOne,
-- 
2.21.0


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