Improve the (short) description of the OsinfoInstallConfigParam and
OsinfoInstallScript classes.
---
osinfo/osinfo_install_config_param.c | 8 +++++---
osinfo/osinfo_install_script.c | 11 ++++++-----
2 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/osinfo/osinfo_install_config_param.c b/osinfo/osinfo_install_config_param.c
index 7876d20..98d0ab1 100644
--- a/osinfo/osinfo_install_config_param.c
+++ b/osinfo/osinfo_install_config_param.c
@@ -34,11 +34,13 @@ G_DEFINE_TYPE (OsinfoInstallConfigParam, osinfo_install_config_param, OSINFO_TYP
/**
* SECTION:osinfo_install_config_param
* @short_description: OS install configuration parameters (and its policies)
- * @see_also: #OsinfoInstallScript, #OsinfoInstallSciptConfig
+ * @see_also: #OsinfoInstallScript, #OsinfoInstallConfig
*
- * #OsinfoInstallConfigParam is an entity for representing all parameters that
+ * #OsinfoInstallConfigParam is an entity for describing all parameters that
* can be set in an automated installation. It is used to help applications to
- * generate an automated installation script
+ * generate an automated installation script. The actual parameter values
+ * for an #OsinfoInstallScript must be set using an #OsinfoInstallConfig
+ * object.
*/
enum {
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 2229843..df37957 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -38,12 +38,13 @@ G_DEFINE_TYPE (OsinfoInstallScript, osinfo_install_script, OSINFO_TYPE_ENTITY);
/**
* SECTION:osinfo_install_script
- * @short_description: OS install scripturation
- * @see_also: #OsinfoInstallScript
+ * @short_description: OS install script generation
+ * @see_also: #OsinfoInstallConfig
*
- * #OsinfoInstallScript is an object for representing OS
- * install scripturation data. It is used to generate an
- * automated installation script
+ * #OsinfoInstallScript is an object used to generate an
+ * automated installation script for an OS. The OS
+ * configuration data (language, keyboard, timezone, ...)
+ * comes from an #OsinfoInstallConfig object.
*/
struct _OsinfoInstallScriptPrivate
--
1.8.0.2
_______________________________________________
Libosinfo mailing list
Libosinfo@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libosinfo
