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

[Libosinfo] [libosinfo PATCH 05/20] Add "Since: 0.2.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_db.c                   |   5 +
 osinfo/osinfo_entity.c               |  25 ++++
 osinfo/osinfo_install_config.c       | 193 ++++++++++++++++++++++++++-
 osinfo/osinfo_install_config_param.c |   6 +
 osinfo/osinfo_install_script.c       |  88 +++++++++++-
 osinfo/osinfo_install_scriptlist.c   |  10 ++
 osinfo/osinfo_os.c                   |  13 ++
 7 files changed, 335 insertions(+), 5 deletions(-)

diff --git a/osinfo/osinfo_db.c b/osinfo/osinfo_db.c
index 43b66eb..29f40b5 100644
--- a/osinfo/osinfo_db.c
+++ b/osinfo/osinfo_db.c
@@ -277,6 +277,8 @@ OsinfoDatamap *osinfo_db_get_datamap(OsinfoDb *db, const gchar *id)
  * @id: the unique operating system identifier
  *
  * Returns: (transfer none): the install script, or NULL if none is found
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScript *osinfo_db_get_install_script(OsinfoDb *db, const gchar *id)
 {
@@ -417,6 +419,8 @@ OsinfoDatamapList *osinfo_db_get_datamap_list(OsinfoDb *db)
  * @db: the database
  *
  * Returns: (transfer full): the list of install scripts
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScriptList *osinfo_db_get_install_script_list(OsinfoDb *db)
 {
@@ -509,6 +513,7 @@ void osinfo_db_add_datamap(OsinfoDb *db, OsinfoDatamap *datamap)
  * @db: the database
  * @script: (transfer none): an install script
  *
+ * Since: 0.2.0
  */
 void osinfo_db_add_install_script(OsinfoDb *db, OsinfoInstallScript *script)
 {
diff --git a/osinfo/osinfo_entity.c b/osinfo/osinfo_entity.c
index f0bfb67..f634d78 100644
--- a/osinfo/osinfo_entity.c
+++ b/osinfo/osinfo_entity.c
@@ -187,6 +187,18 @@ void osinfo_entity_set_param(OsinfoEntity *entity, const gchar *key, const gchar
 }
 
 
+/**
+ * osinfo_entity_set_param_boolean:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ * @value: the boolean value to be associated with that key
+ *
+ * Sets a new parameter against the entity. If the key already
+ * has a value associated with it, the existing value will be
+ * cleared.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_entity_set_param_boolean(OsinfoEntity *entity, const gchar *key, gboolean value)
 {
     osinfo_entity_set_param(entity, key, value ? "true" : "false");
@@ -331,6 +343,19 @@ static gboolean str_to_bool(const char *str)
     return (g_strcmp0("true", str) == 0 || g_strcmp0("yes", str) == 0);
 }
 
+/**
+ * osinfo_entity_get_param_value_boolean:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ *
+ * Retrieve the parameter value associated with a named key as a
+ * boolean. If multiple values are stored against the key, only the
+ * first value is returned. If no value is associated, FALSE is returned
+ *
+ * Returns: the value associated with the key as a boolean, or FALSE
+ *
+ * Since: 0.2.0
+ */
 gboolean osinfo_entity_get_param_value_boolean(OsinfoEntity *entity, const gchar *key)
 {
     const gchar *value = osinfo_entity_get_param_value(entity, key);
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 4a01a81..e8a181e 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -106,6 +106,7 @@ osinfo_install_config_init(OsinfoInstallConfig *config)
  * Returns: (transfer full): an install configuration with default
  * values
  *
+ * Since: 0.2.0
  */
 OsinfoInstallConfig *osinfo_install_config_new(const gchar *id)
 {
@@ -114,6 +115,17 @@ OsinfoInstallConfig *osinfo_install_config_new(const gchar *id)
                         NULL);
 }
 
+/**
+ * osinfo_install_config_set_hardware_arch:
+ * @config: the install config
+ * @arch: the hardware architecture
+ *
+ * Sets the #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter.
+ *
+ * The list of valid architectures are part of osinfo.rng schema
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_hardware_arch(OsinfoInstallConfig *config,
                                              const gchar *arch)
 {
@@ -138,6 +150,8 @@ const gchar *osinfo_install_config_get_hardware_arch(OsinfoInstallConfig *config
  *
  * The expected format of this string is the same as
  * #osinfo_install_config_set_l10n_language function's 'language' parameter.
+ *
+ * Since: 0.2.0
  */
 void osinfo_install_config_set_l10n_keyboard(OsinfoInstallConfig *config,
                                              const gchar *keyboard)
@@ -147,7 +161,15 @@ void osinfo_install_config_set_l10n_keyboard(OsinfoInstallConfig *config,
                             keyboard);
 }
 
-
+/**
+ * osinfo_install_config_get_l10n_keyboard:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_l10n_keyboard(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -168,6 +190,8 @@ const gchar *osinfo_install_config_get_l10n_keyboard(OsinfoInstallConfig *config
  * Encoding and variant are (at least for now) not supported. For example,
  * 'pt_BR' is accepted is accepted as the language codes for Brazilian Portuguese
  * but 'pt_BR.utf8' is not.
+ *
+ * Since: 0.2.0
  */
 void osinfo_install_config_set_l10n_language(OsinfoInstallConfig *config,
                                              const gchar *language)
@@ -178,6 +202,15 @@ void osinfo_install_config_set_l10n_language(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_l10n_language:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_LANGUAGE parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_l10n_language(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -185,6 +218,17 @@ const gchar *osinfo_install_config_get_l10n_language(OsinfoInstallConfig *config
 }
 
 
+/**
+ * osinfo_install_config_set_l10n_timezone:
+ * @config: the install config.
+ * @tz: the timezone
+ *
+ * Set the #OSINFO_INSTALL_CONFIG_PROP_L10B_TIMEZONE parameter.
+ *
+ * The expected format of this string is the tzdata names standard.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_l10n_timezone(OsinfoInstallConfig *config,
                                              const gchar *tz)
 {
@@ -194,6 +238,15 @@ void osinfo_install_config_set_l10n_timezone(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_l10n_timezone:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_TIMEZONE parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_l10n_timezone(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -201,6 +254,15 @@ const gchar *osinfo_install_config_get_l10n_timezone(OsinfoInstallConfig *config
 }
 
 
+/**
+ * osinfo_install_config_set_admin_password:
+ * @config: the install config
+ * @password: the administrator password to be set
+ *
+ * Sets the #OSINFO_INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_admin_password(OsinfoInstallConfig *config,
                                               const gchar *password)
 {
@@ -210,6 +272,15 @@ void osinfo_install_config_set_admin_password(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_admin_password:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_admin_password(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -217,6 +288,15 @@ const gchar *osinfo_install_config_get_admin_password(OsinfoInstallConfig *confi
 }
 
 
+/**
+ * osinfo_install_config_set_user_login:
+ * @config: the install config
+ * @username: the chosen username for the user log into the system
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_LOGIN parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_user_login(OsinfoInstallConfig *config,
                                           const gchar *username)
 {
@@ -226,6 +306,15 @@ void osinfo_install_config_set_user_login(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_user_login:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_USER_LOGIN parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_user_login(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -233,7 +322,15 @@ const gchar *osinfo_install_config_get_user_login(OsinfoInstallConfig *config)
 }
 
 
-
+/**
+ * osinfo_install_config_set_user_password:
+ * @config: the install config
+ * @password: the user password to be set
+ *
+ * Sets the #OSINFO_INSTALL_CONFIG_PROP_USER_PASSWORD parameter
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_user_password(OsinfoInstallConfig *config,
                                              const gchar *password)
 {
@@ -243,6 +340,15 @@ void osinfo_install_config_set_user_password(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_user_password:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_USER_PASSWORD parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_user_password(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -250,6 +356,15 @@ const gchar *osinfo_install_config_get_user_password(OsinfoInstallConfig *config
 }
 
 
+/**
+ * osinfo_install_config_set_user_realname:
+ * @config: the install config
+ * @name: the user real name to be displayed
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_REALNAME parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_user_realname(OsinfoInstallConfig *config,
                                              const gchar *name)
 {
@@ -259,6 +374,15 @@ void osinfo_install_config_set_user_realname(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_user_realname:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_USER_REALNAME parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_config_get_user_realname(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -267,6 +391,15 @@ const gchar *osinfo_install_config_get_user_realname(OsinfoInstallConfig *config
 
 
 
+/**
+ * osinfo_install_config_set_user_autologin:
+ * @config: the install config
+ * @autologin: whether autologin should be set for the user or not
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_AUTOLOGIN parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_user_autologin(OsinfoInstallConfig *config,
                                               gboolean autologin)
 {
@@ -276,6 +409,15 @@ void osinfo_install_config_set_user_autologin(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_user_autologin:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_USER_AUTOLOGIN parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 gboolean osinfo_install_config_get_user_autologin(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value_boolean(OSINFO_ENTITY(config),
@@ -283,6 +425,15 @@ gboolean osinfo_install_config_get_user_autologin(OsinfoInstallConfig *config)
 }
 
 
+/**
+ * osinfo_install_config_set_user_administrator:
+ * @config: the install config
+ * @admin: whether the user should be set as administrator or not
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_ADMIN parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_user_administrator(OsinfoInstallConfig *config,
                                                   gboolean admin)
 {
@@ -292,6 +443,15 @@ void osinfo_install_config_set_user_administrator(OsinfoInstallConfig *config,
 }
 
 
+/**
+ * osinfo_install_config_get_user_administrator:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_USER_ADMIN parameter,
+ *          or NULL.
+ *
+ * Since: 0.2.0
+ */
 gboolean osinfo_install_config_get_user_administrator(OsinfoInstallConfig *config)
 {
     return osinfo_entity_get_param_value_boolean(OSINFO_ENTITY(config),
@@ -299,6 +459,15 @@ gboolean osinfo_install_config_get_user_administrator(OsinfoInstallConfig *confi
 }
 
 
+/**
+ * osinfo_install_config_set_reg_login:
+ * @config: the install config
+ * @name: the registration login
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_LOGIN parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_reg_login(OsinfoInstallConfig *config,
                                          const gchar *name)
 {
@@ -314,6 +483,15 @@ const gchar *osinfo_install_config_get_reg_login(OsinfoInstallConfig *config)
 }
 
 
+/**
+ * osinfo_install_config_set_reg_password:
+ * @config: the install config
+ * @password: the registration password
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_PASSWORD parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_reg_password(OsinfoInstallConfig *config,
                                             const gchar *password)
 {
@@ -329,6 +507,15 @@ const gchar *osinfo_install_config_get_reg_password(OsinfoInstallConfig *config)
 }
 
 
+/**
+ * osinfo_install_config_set_reg_key:
+ * @config: the install config
+ * @key: the registration key
+ *
+ * Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_PRODUCTKEY parameter.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_config_set_reg_product_key(OsinfoInstallConfig *config,
                                                const gchar *key)
 {
@@ -356,6 +543,8 @@ const gchar *osinfo_install_config_get_reg_product_key(OsinfoInstallConfig *conf
  * characters long and make sure that it does not contain any characters other
  * than ASCII alphanumeric and '-'. Otherwise unattended installation might
  * fail.
+ *
+ * Since: 0.2.0
  */
 void osinfo_install_config_set_hostname(OsinfoInstallConfig *config,
                                         const gchar *hostname)
diff --git a/osinfo/osinfo_install_config_param.c b/osinfo/osinfo_install_config_param.c
index 3b44d3d..187569f 100644
--- a/osinfo/osinfo_install_config_param.c
+++ b/osinfo/osinfo_install_config_param.c
@@ -206,6 +206,8 @@ osinfo_install_config_param_init(OsinfoInstallConfigParam *config_param)
  * Construct a new configuration parameter for an #OsinfoInstallScript.
  *
  * Returns: (transfer full): the new configuration parameter
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallConfigParam *osinfo_install_config_param_new(const gchar *name)
 {
@@ -220,6 +222,8 @@ OsinfoInstallConfigParam *osinfo_install_config_param_new(const gchar *name)
  * @config_param: the configuration parameter
  *
  * Returns: (transfer none): the name of the configuration parameter
+ *
+ * Since: 0.2.0
  */
 const gchar *osinfo_install_config_param_get_name(OsinfoInstallConfigParam *config_param)
 {
@@ -232,6 +236,8 @@ const gchar *osinfo_install_config_param_get_name(OsinfoInstallConfigParam *conf
  * @config_param: the configuration parameter
  *
  * Returns: (transfer none): the policy of the configuration parameter
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallConfigParamPolicy osinfo_install_config_param_get_policy(OsinfoInstallConfigParam *config_param)
 {
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 942197f..b9714e3 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -311,15 +311,32 @@ void osinfo_install_script_add_config_param(OsinfoInstallScript *script, OsinfoI
                     OSINFO_ENTITY(param));
 }
 
+/**
+ * osinfo_install_script_has_config_param:
+ * @script: the install script
+ * @config_param: an #OsinfoInstallConfigParam
+ *
+ * Returns whether the @script has the @config_param searched or not.
+ *
+ * This code assumes that the 'id' and 'name' entity properties are the same.
+ *
+ * Since: 0.2.0
+ */
 gboolean osinfo_install_script_has_config_param(OsinfoInstallScript *script, OsinfoInstallConfigParam *config_param)
 {
-    /* NB: this code assumes that the 'id' and 'name' entity properties
-     * are the same
-     */
     const char *name = osinfo_install_config_param_get_name(config_param);
     return osinfo_install_script_has_config_param_name(script, name);
 }
 
+/**
+ * osinfo_install_script_has_config_param_name:
+ * @script: the install script
+ * @name: the configuration parameter name
+ *
+ * Returns whether the @script has a configuration parameter matching @name or not.
+ *
+ * Since: 0.2.0
+ */
 gboolean osinfo_install_script_has_config_param_name(OsinfoInstallScript *script, const gchar *name)
 {
     OsinfoList *l = OSINFO_LIST(script->priv->config_params);
@@ -335,6 +352,8 @@ gboolean osinfo_install_script_has_config_param_name(OsinfoInstallScript *script
  * Returns: (transfer container) (element-type OsinfoInstallScript): the
  * list of valid #OsinfoInstallConfigParam parameters. Free with
  * g_list_free() when done. The elements are owned by libosinfo.
+ *
+ * Since: 0.2.0
  */
 GList *osinfo_install_script_get_config_param_list(OsinfoInstallScript *script)
 {
@@ -389,6 +408,16 @@ osinfo_install_script_init(OsinfoInstallScript *list)
 }
 
 
+/**
+ * oisinfo_install_script_new:
+ * @id: a unique identifier
+ *
+ * Construct an empty new install script.
+ *
+ * Returns: (transfer full): a new install script
+ *
+ * Since: 0.2.0
+ */
 OsinfoInstallScript *osinfo_install_script_new(const gchar *id)
 {
     return g_object_new(OSINFO_TYPE_INSTALL_SCRIPT,
@@ -405,6 +434,8 @@ OsinfoInstallScript *osinfo_install_script_new(const gchar *id)
  * Construct a new install script from stylesheet data
  *
  * Returns: (transfer full): an new install script
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScript *osinfo_install_script_new_data(const gchar *id,
                                                     const gchar *profile,
@@ -427,6 +458,8 @@ OsinfoInstallScript *osinfo_install_script_new_data(const gchar *id,
  * Construct a new install script from a stylesheet URI
  *
  * Returns: (transfer full): an new install script
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScript *osinfo_install_script_new_uri(const gchar *id,
                                                    const gchar *profile,
@@ -440,18 +473,46 @@ OsinfoInstallScript *osinfo_install_script_new_uri(const gchar *id,
 }
 
 
+/**
+ * osinfo_install_script_get_template_uri:
+ * @script: the install script
+ *
+ * Returns the stylesheet URI used to construct the install script.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_script_get_template_uri(OsinfoInstallScript *script)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(script),
                                          OSINFO_INSTALL_SCRIPT_PROP_TEMPLATE_URI);
 }
 
+/**
+ * osinfo_install_script_get_template_data:
+ * @script: the install script
+ *
+ * Returns the stylesheet data used to construct the install script.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_script_get_template_data(OsinfoInstallScript *script)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(script),
                                          OSINFO_INSTALL_SCRIPT_PROP_TEMPLATE_DATA);
 }
 
+/**
+ * osinfo_install_script_get_profile:
+ * @script: the install script
+ *
+ * Returns a string representing the install script profile that's going to be
+ * used.
+ *
+ * The values supported are "jeos" for minimal installations and "desktop" for
+ * workstation/desktop installations.
+ *
+ * Since: 0.2.0
+ */
 const gchar *osinfo_install_script_get_profile(OsinfoInstallScript *script)
 {
     return osinfo_entity_get_param_value(OSINFO_ENTITY(script),
@@ -488,6 +549,15 @@ const gchar *osinfo_install_script_get_product_key_format(OsinfoInstallScript *s
                                          OSINFO_INSTALL_SCRIPT_PROP_PRODUCT_KEY_FORMAT);
 }
 
+/**
+ * osinfo_install_script_set_output_prefix:
+ * @script: the install script
+ * @prefix: a prefix to be added to the file generated
+ *
+ * Mind that not all installers support any name for the installer scripts.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_install_script_set_output_prefix(OsinfoInstallScript *script,
                                              const gchar *prefix)
 {
@@ -535,6 +605,8 @@ const gchar *osinfo_install_script_get_expected_filename(OsinfoInstallScript *sc
  * osinfo_install_script_set_output_prefix() function.
  *
  * Returns: (transfer none): the output script filename
+ *
+ * Since: 0.2.0
  */
 const gchar *osinfo_install_script_get_output_filename(OsinfoInstallScript *script)
 {
@@ -1041,6 +1113,8 @@ static void osinfo_install_script_generate_async_common(OsinfoInstallScript *scr
  *
  * If you are generating the script for a specific media, it is recommended that
  * you use #osinfo_install_script_generate_for_media_async() instead.
+ *
+ * Since: 0.2.0
  */
 void osinfo_install_script_generate_async(OsinfoInstallScript *script,
                                           OsinfoOs *os,
@@ -1076,6 +1150,8 @@ static gpointer osinfo_install_script_generate_finish_common(OsinfoInstallScript
  * @error:  The location where to store any error, or NULL
  *
  * Returns: (transfer full): the generated script, or NULL on error
+ *
+ * Since: 0.2.0
  */
 gchar *osinfo_install_script_generate_finish(OsinfoInstallScript *script,
                                              GAsyncResult *res,
@@ -1216,6 +1292,8 @@ static void osinfo_install_script_generate_done(GObject *src,
  *
  * If you are generating the script for a specific media, it is recommended
  * that you use #osinfo_install_script_generate_for_media() instead.
+ *
+ * Since: 0.2.0
  */
 gchar *osinfo_install_script_generate(OsinfoInstallScript *script,
                                       OsinfoOs *os,
@@ -1450,6 +1528,8 @@ static void osinfo_install_script_generate_output_async_common(OsinfoInstallScri
  *
  * If you are generating the script for a specific media, it is recommended that
  * you use #osinfo_install_script_generate_output_for_media_async() instead.
+ *
+ * Since: 0.2.0
  */
 void osinfo_install_script_generate_output_async(OsinfoInstallScript *script,
                                                  OsinfoOs *os,
@@ -1529,6 +1609,8 @@ static GFile *osinfo_install_script_generate_output_common(OsinfoInstallScript *
  *
  * If you are generating the script for a specific media, it is recommended
  * that you use #osinfo_install_script_generate_output_for_media() instead.
+ *
+ * Since: 0.2.0
  */
 GFile *osinfo_install_script_generate_output(OsinfoInstallScript *script,
                                              OsinfoOs *os,
diff --git a/osinfo/osinfo_install_scriptlist.c b/osinfo/osinfo_install_scriptlist.c
index 26e1f04..9fba971 100644
--- a/osinfo/osinfo_install_scriptlist.c
+++ b/osinfo/osinfo_install_scriptlist.c
@@ -74,6 +74,8 @@ osinfo_install_scriptlist_init(OsinfoInstallScriptList *list)
  * Construct a new install_script list that is initially empty.
  *
  * Returns: (transfer full): an empty install_script list
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScriptList *osinfo_install_scriptlist_new(void)
 {
@@ -90,6 +92,8 @@ OsinfoInstallScriptList *osinfo_install_scriptlist_new(void)
  * from @source
  *
  * Returns: (transfer full): a copy of the install_script list
+ *
+ * Since: 0.2.0
  * Deprecated: 0.2.2: Use osinfo_list_new_copy() instead.
  */
 OsinfoInstallScriptList *osinfo_install_scriptlist_new_copy(OsinfoInstallScriptList *source)
@@ -109,6 +113,8 @@ OsinfoInstallScriptList *osinfo_install_scriptlist_new_copy(OsinfoInstallScriptL
  * from @source that match @filter
  *
  * Returns: (transfer full): a filtered copy of the install_script list
+ *
+ * Since: 0.2.0
  * Deprecated: 0.2.2: Use osinfo_list_new_filtered() instead.
  */
 OsinfoInstallScriptList *osinfo_install_scriptlist_new_filtered(OsinfoInstallScriptList *source,
@@ -130,6 +136,8 @@ OsinfoInstallScriptList *osinfo_install_scriptlist_new_filtered(OsinfoInstallScr
  * install_scripts that are present in both @sourceOne and @sourceTwo.
  *
  * Returns: (transfer full): an intersection of the two install_script lists
+ *
+ * Since: 0.2.0
  * Deprecated: 0.2.2: Use osinfo_list_new_intersection() instead.
  */
 OsinfoInstallScriptList *osinfo_install_scriptlist_new_intersection(OsinfoInstallScriptList *sourceOne,
@@ -151,6 +159,8 @@ OsinfoInstallScriptList *osinfo_install_scriptlist_new_intersection(OsinfoInstal
  * install_scripts that are present in either @sourceOne and @sourceTwo.
  *
  * Returns: (transfer full): a union of the two install_script lists
+ *
+ * Since: 0.2.0
  * Deprecated: 0.2.2: Use osinfo_list_new_union() instead.
  */
 OsinfoInstallScriptList *osinfo_install_scriptlist_new_union(OsinfoInstallScriptList *sourceOne,
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 82af6b7..b2a71ce 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -1093,6 +1093,8 @@ void osinfo_os_add_network_install_resources(OsinfoOs *os,
  * OSINFO_INSTALL_SCRIPT_PROFILE_DESKTOP or OSINFO_INSTALL_SCRIPT_PROFILE_JEOS
  *
  * Returns: (transfer none): A new #OsinfoInstallScript for the @os @profile
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScript *osinfo_os_find_install_script(OsinfoOs *os, const gchar *profile)
 {
@@ -1126,6 +1128,8 @@ OsinfoInstallScript *osinfo_os_find_install_script(OsinfoOs *os, const gchar *pr
  * @os: an operating system
  *
  * Returns: (transfer full): a list of the install scripts for the specified os
+ *
+ * Since: 0.2.0
  */
 OsinfoInstallScriptList *osinfo_os_get_install_script_list(OsinfoOs *os)
 {
@@ -1138,6 +1142,15 @@ OsinfoInstallScriptList *osinfo_os_get_install_script_list(OsinfoOs *os)
 }
 
 
+/**
+ * osinfo_os_add_install_script:
+ * @os: an operating system
+ * @script: (transfer none): the install script to add
+ *
+ * Adds @script to the list of scripts of operating system @os.
+ *
+ * Since: 0.2.0
+ */
 void osinfo_os_add_install_script(OsinfoOs *os, OsinfoInstallScript *script)
 {
     g_return_if_fail(OSINFO_IS_OS(os));
-- 
2.21.0


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