[Libosinfo] [PATCH 1/2] docs: Fix couple of warnings

Michal Privoznik mprivozn at redhat.com
Mon Jan 16 08:06:50 UTC 2017


Firstly, two functions
(osinfo_install_script_has_config_param_{name,list}) don't
document their arguments.  Secondly, gtk-doc requires enum
documentation to be in one block with no empty lines in it.
Then at last, private enums are marked as <private> not <skip>.

Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
---
 osinfo/osinfo_install_script.c  | 2 ++
 osinfo/osinfo_install_script.h  | 4 ----
 osinfo/osinfo_product_private.h | 2 +-
 3 files changed, 3 insertions(+), 5 deletions(-)

diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 9206101..8fcde0f 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -283,6 +283,7 @@ gboolean osinfo_install_script_has_config_param_name(const OsinfoInstallScript *
 
 /**
  * osinfo_install_script_get_config_param_list:
+ * @script: the install script
  *
  * Get the list of valid config parameters for @script.
  *
@@ -297,6 +298,7 @@ GList *osinfo_install_script_get_config_param_list(const OsinfoInstallScript *sc
 
 /**
  * osinfo_install_script_get_config_params:
+ * @script: the install script
  *
  * Get the list of valid config parameters for @script.
  *
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index c494192..61bf0e4 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -93,17 +93,14 @@ typedef enum {
 
 /**
  * OsinfoDeviceDriverSigningReq:
- *
  * @OSINFO_DEVICE_DRIVER_SIGNING_REQ_NONE: Script do not require device drivers
  * to be signed.
- *
  * @OSINFO_DEVICE_DRIVER_SIGNING_REQ_STRICT: Script must only be given signed
  * device drivers. Some scripts will allow overriding this requirement through
  * #osinfo_install_config_set_driver_signing function. You can query if a
  * script supports this by checking if
  * #OSINFO_INSTALL_CONFIG_PROP_DRIVER_SIGNING configuration parameter is used
  * by the script in question (or other scripts in the same profile).
- *
  * @OSINFO_DEVICE_DRIVER_SIGNING_REQ_WARN: A warning will be issued by OS
  * installer if device drivers are not signed and most probably require user
  * input (and thus breaking unattended installation). See
@@ -118,7 +115,6 @@ typedef enum {
 
 /**
  * OsinfoInstallScriptInjectionMethod:
- *
  * @OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_CDROM: Support injection of the
  * installation script trough a CD-ROM.
  * @OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK: Support injection of the
diff --git a/osinfo/osinfo_product_private.h b/osinfo/osinfo_product_private.h
index c4ecdd5..49cf0a2 100644
--- a/osinfo/osinfo_product_private.h
+++ b/osinfo/osinfo_product_private.h
@@ -29,7 +29,7 @@
 
 typedef void (*OsinfoProductForeach)(OsinfoProduct *product, gpointer user_data);
 
-typedef enum { /*< skip >*/
+typedef enum { /*< private >*/
     OSINFO_PRODUCT_FOREACH_FLAG_DERIVES_FROM = 1 << 0,
     OSINFO_PRODUCT_FOREACH_FLAG_UPGRADES = 1 << 1,
     OSINFO_PRODUCT_FOREACH_FLAG_CLONES = 1 << 2,
-- 
2.11.0




More information about the Libosinfo mailing list