[Libosinfo] [libosinfo PATCH 11/20] Add "Since: 0.2.8" to the documentation
Fabiano Fidêncio
fidencio at redhat.com
Mon Jul 15 13:01:49 UTC 2019
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 at redhat.com>
---
osinfo/osinfo_avatar_format.c | 2 ++
osinfo/osinfo_install_config.c | 45 ++++++++++++++++++++++++++++
osinfo/osinfo_install_config_param.c | 11 +++++++
osinfo/osinfo_install_script.c | 8 +++++
osinfo/osinfo_loader.c | 22 +++++++++++++-
osinfo/osinfo_product.c | 40 +++++++++++++++++++++++++
6 files changed, 127 insertions(+), 1 deletion(-)
diff --git a/osinfo/osinfo_avatar_format.c b/osinfo/osinfo_avatar_format.c
index ade4d09..3580e81 100644
--- a/osinfo/osinfo_avatar_format.c
+++ b/osinfo/osinfo_avatar_format.c
@@ -175,6 +175,8 @@ osinfo_avatar_format_init(OsinfoAvatarFormat *avatar)
*
* Returns: (transfer full): the necessary information to create an avatar for
* an user
+ *
+ * Since: 0.2.8
*/
OsinfoAvatarFormat *
osinfo_avatar_format_new(void)
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 2bd5e4b..3d072d9 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -135,6 +135,15 @@ void osinfo_install_config_set_hardware_arch(OsinfoInstallConfig *config,
}
+/**
+ * osinfo_install_config_get_hardware_arch:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_hardware_arch(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -476,6 +485,15 @@ void osinfo_install_config_set_reg_login(OsinfoInstallConfig *config,
name);
}
+/**
+ * osinfo_install_config_get_reg_login:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_REG_LOGIN paramater,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_reg_login(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -500,6 +518,15 @@ void osinfo_install_config_set_reg_password(OsinfoInstallConfig *config,
password);
}
+/**
+ * osinfo_install_config_get_reg_password:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_REG_PASSWORD paramater,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_reg_password(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -524,6 +551,15 @@ void osinfo_install_config_set_reg_product_key(OsinfoInstallConfig *config,
key);
}
+/**
+ * osinfo_install_config_get_reg_product_key:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_REG_PRODUCTKEY paramater,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_reg_product_key(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -554,6 +590,15 @@ void osinfo_install_config_set_hostname(OsinfoInstallConfig *config,
hostname);
}
+/**
+ * osinfo_install_config_get_hostname:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_HOSTNAME parameter,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_hostname(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
diff --git a/osinfo/osinfo_install_config_param.c b/osinfo/osinfo_install_config_param.c
index ab854b3..13fa088 100644
--- a/osinfo/osinfo_install_config_param.c
+++ b/osinfo/osinfo_install_config_param.c
@@ -277,6 +277,15 @@ gboolean osinfo_install_config_param_is_optional(OsinfoInstallConfigParam *confi
OSINFO_INSTALL_CONFIG_PARAM_POLICY_OPTIONAL);
}
+/**
+ * osinfo_install_config_get_value_map:
+ * @config_param: the configuration parameter
+ *
+ * Returns: (transfer none): The data map used to transform values set for this
+ * parameter to OS-specific values, or NULL.
+ *
+ * Since: 0.2.8
+ */
OsinfoDatamap *osinfo_install_config_param_get_value_map(OsinfoInstallConfigParam *config_param)
{
return config_param->priv->value_map;
@@ -291,6 +300,8 @@ OsinfoDatamap *osinfo_install_config_param_get_value_map(OsinfoInstallConfigPara
* After a call to osinfo_install_config_param_set_value_map(), @datamap will
* be used to transform values set for this parameter to OS-specific
* values. A NULL @datamap will disable transformations.
+ *
+ * Since: 0.2.8
*/
void osinfo_install_config_param_set_value_map(OsinfoInstallConfigParam *config_param, OsinfoDatamap *datamap)
{
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index d9a0ee7..173e9c6 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -581,6 +581,14 @@ void osinfo_install_script_set_output_prefix(OsinfoInstallScript *script,
NULL);
}
+/**
+ * osinfo_install_script_get_output_prefix:
+ * @script: the install script
+ *
+ * Returns: the prefix of the file generated
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_script_get_output_prefix(OsinfoInstallScript *script)
{
return script->priv->output_prefix;
diff --git a/osinfo/osinfo_loader.c b/osinfo/osinfo_loader.c
index 7735357..6d1c801 100644
--- a/osinfo/osinfo_loader.c
+++ b/osinfo/osinfo_loader.c
@@ -2603,7 +2603,9 @@ void osinfo_loader_process_default_path(OsinfoLoader *loader, GError **err)
* @loader: the loader object
* @err: (out): filled with error information upon failure
*
- * Loads data from the default paths.
+ * Loads data from the system path.
+ *
+ * Since: 0.2.8
*/
void osinfo_loader_process_system_path(OsinfoLoader *loader,
GError **err)
@@ -2621,6 +2623,15 @@ void osinfo_loader_process_system_path(OsinfoLoader *loader,
g_object_unref(dirs[2]);
}
+/**
+ * osinfo_loader_process_local_path:
+ * @loader: the loader object
+ * @err: (out): filled with error information upen failures
+ *
+ * Loads data from the local path.
+ *
+ * Since: 0.2.8
+ */
void osinfo_loader_process_local_path(OsinfoLoader *loader, GError **err)
{
GFile *dirs[] = {
@@ -2632,6 +2643,15 @@ void osinfo_loader_process_local_path(OsinfoLoader *loader, GError **err)
g_object_unref(dirs[0]);
}
+/**
+ * osinfo_loader_process_user_path:
+ * @loader: the loader object
+ * @err: (out): filled with error information upen failures
+ *
+ * Loads data from user path.
+ *
+ * Since: 0.2.8
+ */
void osinfo_loader_process_user_path(OsinfoLoader *loader, GError **err)
{
GFile *dirs[] = {
diff --git a/osinfo/osinfo_product.c b/osinfo/osinfo_product.c
index a598312..dbb7402 100644
--- a/osinfo/osinfo_product.c
+++ b/osinfo/osinfo_product.c
@@ -315,16 +315,38 @@ const gchar *osinfo_product_get_name(OsinfoProduct *prod)
return osinfo_entity_get_param_value(OSINFO_ENTITY(prod), OSINFO_PRODUCT_PROP_NAME);
}
+/**
+ * osinfo_product_get_codename:
+ * @product: an product
+ *
+ * Returns: The product's codename, or NULL.
+ */
const gchar *osinfo_product_get_codename(OsinfoProduct *prod)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(prod), OSINFO_PRODUCT_PROP_CODENAME);
}
+/**
+ * osinfo_product_get_release_date_string:
+ * @product: an product
+ *
+ * Returns: A string representing the product's release date, or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_product_get_release_date_string(OsinfoProduct *prod)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(prod), OSINFO_PRODUCT_PROP_RELEASE_DATE);
}
+/**
+ * osinfo_product_get_eol_date_string:
+ * @product: an product
+ *
+ * Returns: A string representing the product's EOL date, or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_product_get_eol_date_string(OsinfoProduct *prod)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(prod), OSINFO_PRODUCT_PROP_EOL_DATE);
@@ -344,6 +366,15 @@ static GDate *date_from_string(const gchar *str)
return g_date_new_dmy(d, m, y);
}
+/**
+ * osinfo_product_get_release_date:
+ * @product: an product
+ *
+ * Returns: (transfer full): A #GDate representing the product's release date,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
GDate *osinfo_product_get_release_date(OsinfoProduct *prod)
{
const gchar *str = osinfo_product_get_release_date_string(prod);
@@ -354,6 +385,15 @@ GDate *osinfo_product_get_release_date(OsinfoProduct *prod)
}
+/**
+ * osinfo_product_get_eol_date:
+ * @product: an product
+ *
+ * Returns: (transfer full): A #GDate representing the product's EOL date,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
GDate *osinfo_product_get_eol_date(OsinfoProduct *prod)
{
const gchar *str = osinfo_product_get_eol_date_string(prod);
--
2.21.0
More information about the Libosinfo
mailing list