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

[virt-tools-list] [PATCH 4/4] Document even more arguments



These files were still missing function arguments description:
 * osinfo/osinfo_install_script.c
 * osinfo/osinfo_os.c
---
 osinfo/osinfo_install_script.c |   14 ++++++++++++++
 osinfo/osinfo_os.c             |    1 +
 2 files changed, 15 insertions(+), 0 deletions(-)

diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index b891aaf..9d5abf4 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -296,6 +296,8 @@ GList *osinfo_install_script_get_config_param_list(const OsinfoInstallScript *sc
 
 /**
  * osinfo_install_script_get_config_param:
+ * @script: the install script
+ * @name: name of the parameter
  *
  * Get a config param from the config param's list
  *
@@ -337,6 +339,9 @@ OsinfoInstallScript *osinfo_install_script_new(const gchar *id)
 
 /**
  * osinfo_install_script_new_data:
+ * @id: a unique identifier
+ * @profile: the profile of script
+ * @templateData: style sheet data
  *
  * Construct a new install script from stylesheet data
  *
@@ -356,6 +361,9 @@ OsinfoInstallScript *osinfo_install_script_new_data(const gchar *id,
 
 /**
  * osinfo_install_script_new_uri:
+ * @id: a unique identifier
+ * @profile: the profile of script
+ * @templateUri: style sheet URI
  *
  * Construct a new install script from a stylesheet URI
  *
@@ -393,6 +401,7 @@ const gchar *osinfo_install_script_get_profile(OsinfoInstallScript *script)
 
 /**
  * osinfo_install_script_get_product_key_format:
+ * @script: the install script
  *
  * If this function returns a non-NULL string, it means that the @script
  * requires you to specify product registration key through #OsinfoInstallConfig
@@ -444,6 +453,7 @@ const gchar *osinfo_install_script_get_output_prefix(OsinfoInstallScript *script
 
 /**
  * osinfo_install_script_get_expected_filename:
+ * @script: the install script
  *
  * Some operating systems (as Windows) expect that script filename has
  * particular name to work.
@@ -458,6 +468,7 @@ const gchar *osinfo_install_script_get_expected_filename(OsinfoInstallScript *sc
 
 /**
  * osinfo_install_script_get_output_filename:
+ * @script: the install script
  *
  * Some operating systems are able to use any script filename, allowing the
  * application to set the filename as desired. libosinfo provides this
@@ -488,6 +499,7 @@ osinfo_install_script_set_avatar_format(OsinfoInstallScript *script,
 
 /**
  * osinfo_install_script_get_avatar_format
+ * @script: the install script
  *
  * Some install scripts have restrictions on the format of the user avatar. Use
  * this method to retrieve those restrictions in the form of an
@@ -1057,6 +1069,8 @@ void osinfo_install_script_generate_output_async(OsinfoInstallScript *script,
  * @config:     the install script config
  * @output_dir: the directory where file containing the output script
  *              will be written
+ * @cancellable: (allow-none): a #GCancellable, or %NULL
+ * @error: The location where to store any error, or %NULL
  *
  * Creates a install script written in a file
  *
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index b91c4d9..89b941f 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -559,6 +559,7 @@ OsinfoInstallScript *osinfo_os_find_install_script(OsinfoOs *os, const gchar *pr
 
 /**
  * osinfo_os_get_install_script_list:
+ * @os: an operating system
  *
  * Returns: (transfer full): a list of the install scripts for the specified os
  */
-- 
1.7.8.6


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