[libosinfo 1/3] Add missing documentation

[Fabiano Fidêncio <fabiano@xxxxxxxxxxxx>]

---
 osinfo/osinfo_install_script.c |  8 ++++++++
 osinfo/osinfo_media.c          | 15 +++++++++++++--
 osinfo/osinfo_os.c             |  8 +++++++-
 3 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 2229843..b2055d0 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -898,6 +898,14 @@ gchar *osinfo_install_script_generate_finish(OsinfoInstallScript *script,
                                                         error);
 }
 
+/**
+ * osinfo_install_script_generate_output_finish:
+ * @script: the install script
+ * @res:    a #GAsyncResult
+ * @error:  The location where to store any error, or NULL
+ *
+ * Returns: (transfer full): a file containing the script, or NULL on error
+ */
 GFile *osinfo_install_script_generate_output_finish(OsinfoInstallScript *script,
                                                     GAsyncResult *res,
                                                     GError **error)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index 0bb29fa..2821e7f 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -1114,8 +1114,11 @@ gint osinfo_media_get_installer_reboots(OsinfoMedia *media)
             (OSINFO_ENTITY(media), OSINFO_MEDIA_PROP_INSTALLER_REBOOTS, 1);
 }
 
-/* osinfo_media_get_os:
- * Returns: (transfer full):
+/**
+ * osinfo_media_get_os:
+ * @media: an #OsinfoMedia instance
+ *
+ * Returns: (transfer full): the operating system, or NULL
  */
 OsinfoOs *osinfo_media_get_os(OsinfoMedia *media)
 {
@@ -1156,6 +1159,14 @@ GList *osinfo_media_get_languages(OsinfoMedia *media)
     return osinfo_entity_get_param_value_list(OSINFO_ENTITY(media), OSINFO_MEDIA_PROP_LANG);
 }
 
+/**
+ * osinfo_media_set_languages:
+ * @media: an #OsinfoMedia instance
+ * @languages: (element-type utf8): a #GList containing the list of the UI
+ * languages this media supports.
+ *
+ * Sets the #OSINFO_MEDIA_PROP_LANG parameter
+ */
 void osinfo_media_set_languages(OsinfoMedia *media, GList *languages)
 {
     GList *it;
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 2be7f64..786e596 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -538,7 +538,13 @@ void osinfo_os_add_recommended_resources(OsinfoOs *os,
                     OSINFO_ENTITY(resources));
 }
 
-
+/**
+ * osinfo_os_find_install_script:
+ * @os:      an operating system
+ * @profile: the install script profile
+ *
+ * Returns: (transfer full): A new #OsinfoInstallScript for the @os @profile
+ */
 OsinfoInstallScript *osinfo_os_find_install_script(OsinfoOs *os, const gchar *profile)
 {
     g_return_val_if_fail(OSINFO_IS_OS(os), NULL);
-- 
1.8.0.2

_______________________________________________
virt-tools-list mailing list
virt-tools-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/virt-tools-list