[virt-tools-list] [PATCH 1/4] Suppress gtk-doc warnings on missing field description

Michal Privoznik mprivozn at redhat.com
Fri Dec 7 13:22:12 UTC 2012


Each public visible struct and enum must have documented
items. If it hasn't, gtk-doc produces a lot of warnings.
However, things it's complaining about doesn't have any
interesting attributes, so mark them as private.
---
 osinfo/osinfo_avatar_format.h        |    1 +
 osinfo/osinfo_db.h                   |    1 +
 osinfo/osinfo_deployment.h           |    1 +
 osinfo/osinfo_deploymentlist.h       |    1 +
 osinfo/osinfo_device.h               |    1 +
 osinfo/osinfo_device_driver.h        |    1 +
 osinfo/osinfo_device_driverlist.h    |    1 +
 osinfo/osinfo_devicelink.h           |    1 +
 osinfo/osinfo_devicelinkfilter.h     |    1 +
 osinfo/osinfo_devicelinklist.h       |    1 +
 osinfo/osinfo_devicelist.h           |    1 +
 osinfo/osinfo_entity.h               |    1 +
 osinfo/osinfo_filter.h               |    1 +
 osinfo/osinfo_install_config.h       |    1 +
 osinfo/osinfo_install_config_param.h |    1 +
 osinfo/osinfo_install_script.h       |    5 +++--
 osinfo/osinfo_install_scriptlist.h   |    1 +
 osinfo/osinfo_list.h                 |    1 +
 osinfo/osinfo_loader.h               |    1 +
 osinfo/osinfo_media.h                |    1 +
 osinfo/osinfo_medialist.h            |    1 +
 osinfo/osinfo_os.h                   |    1 +
 osinfo/osinfo_oslist.h               |    1 +
 osinfo/osinfo_platform.h             |    1 +
 osinfo/osinfo_platformlist.h         |    1 +
 osinfo/osinfo_product.h              |    1 +
 osinfo/osinfo_productfilter.h        |    1 +
 osinfo/osinfo_productlist.h          |    1 +
 osinfo/osinfo_resources.h            |    1 +
 osinfo/osinfo_resourceslist.h        |    1 +
 osinfo/osinfo_tree.h                 |    1 +
 osinfo/osinfo_treelist.h             |    1 +
 32 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/osinfo/osinfo_avatar_format.h b/osinfo/osinfo_avatar_format.h
index fc4e03d..ef5e52c 100644
--- a/osinfo/osinfo_avatar_format.h
+++ b/osinfo/osinfo_avatar_format.h
@@ -73,6 +73,7 @@ struct _OsinfoAvatarFormat
 /* class */
 struct _OsinfoAvatarFormatClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 };
 
diff --git a/osinfo/osinfo_db.h b/osinfo/osinfo_db.h
index d789802..0effefd 100644
--- a/osinfo/osinfo_db.h
+++ b/osinfo/osinfo_db.h
@@ -65,6 +65,7 @@ struct _OsinfoDb
 /* class */
 struct _OsinfoDbClass
 {
+    /*< private >*/
     GObjectClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_deployment.h b/osinfo/osinfo_deployment.h
index 2d83e42..70c170e 100644
--- a/osinfo/osinfo_deployment.h
+++ b/osinfo/osinfo_deployment.h
@@ -59,6 +59,7 @@ struct _OsinfoDeployment
 /* class */
 struct _OsinfoDeploymentClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_deploymentlist.h b/osinfo/osinfo_deploymentlist.h
index f476257..37dde9a 100644
--- a/osinfo/osinfo_deploymentlist.h
+++ b/osinfo/osinfo_deploymentlist.h
@@ -59,6 +59,7 @@ struct _OsinfoDeploymentList
 /* class */
 struct _OsinfoDeploymentListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_device.h b/osinfo/osinfo_device.h
index 240d583..7ce4259 100644
--- a/osinfo/osinfo_device.h
+++ b/osinfo/osinfo_device.h
@@ -68,6 +68,7 @@ struct _OsinfoDevice
 /* class */
 struct _OsinfoDeviceClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_device_driver.h b/osinfo/osinfo_device_driver.h
index 81e462c..c894fe8 100644
--- a/osinfo/osinfo_device_driver.h
+++ b/osinfo/osinfo_device_driver.h
@@ -70,6 +70,7 @@ struct _OsinfoDeviceDriver
 /* class */
 struct _OsinfoDeviceDriverClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_device_driverlist.h b/osinfo/osinfo_device_driverlist.h
index 39724a8..02d9470 100644
--- a/osinfo/osinfo_device_driverlist.h
+++ b/osinfo/osinfo_device_driverlist.h
@@ -67,6 +67,7 @@ struct _OsinfoDeviceDriverList
 /* class */
 struct _OsinfoDeviceDriverListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_devicelink.h b/osinfo/osinfo_devicelink.h
index a63ca83..0ed32ca 100644
--- a/osinfo/osinfo_devicelink.h
+++ b/osinfo/osinfo_devicelink.h
@@ -60,6 +60,7 @@ struct _OsinfoDeviceLink
 /* class */
 struct _OsinfoDeviceLinkClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_devicelinkfilter.h b/osinfo/osinfo_devicelinkfilter.h
index 3d6f661..ae7c4a1 100644
--- a/osinfo/osinfo_devicelinkfilter.h
+++ b/osinfo/osinfo_devicelinkfilter.h
@@ -55,6 +55,7 @@ struct _OsinfoDeviceLinkFilter
 /* class */
 struct _OsinfoDeviceLinkFilterClass
 {
+    /*< private >*/
     OsinfoFilterClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_devicelinklist.h b/osinfo/osinfo_devicelinklist.h
index 56812e0..88cc5b0 100644
--- a/osinfo/osinfo_devicelinklist.h
+++ b/osinfo/osinfo_devicelinklist.h
@@ -59,6 +59,7 @@ struct _OsinfoDeviceLinkList
 /* class */
 struct _OsinfoDeviceLinkListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_devicelist.h b/osinfo/osinfo_devicelist.h
index c12faa9..6dd5d0e 100644
--- a/osinfo/osinfo_devicelist.h
+++ b/osinfo/osinfo_devicelist.h
@@ -59,6 +59,7 @@ struct _OsinfoDeviceList
 /* class */
 struct _OsinfoDeviceListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_entity.h b/osinfo/osinfo_entity.h
index 7a2654c..4c6dc45 100644
--- a/osinfo/osinfo_entity.h
+++ b/osinfo/osinfo_entity.h
@@ -59,6 +59,7 @@ struct _OsinfoEntity
 /* class */
 struct _OsinfoEntityClass
 {
+    /*< private >*/
     GObjectClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_filter.h b/osinfo/osinfo_filter.h
index 8199ee3..a3d4f89 100644
--- a/osinfo/osinfo_filter.h
+++ b/osinfo/osinfo_filter.h
@@ -58,6 +58,7 @@ struct _OsinfoFilter
 /* class */
 struct _OsinfoFilterClass
 {
+    /*< private >*/
     GObjectClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_install_config.h b/osinfo/osinfo_install_config.h
index 18c2c2f..d650a0a 100644
--- a/osinfo/osinfo_install_config.h
+++ b/osinfo/osinfo_install_config.h
@@ -85,6 +85,7 @@ struct _OsinfoInstallConfig
 /* class */
 struct _OsinfoInstallConfigClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_install_config_param.h b/osinfo/osinfo_install_config_param.h
index 930614d..dfed04e 100644
--- a/osinfo/osinfo_install_config_param.h
+++ b/osinfo/osinfo_install_config_param.h
@@ -62,6 +62,7 @@ struct _OsinfoInstallConfigParam
 /* class */
 struct _OsinfoInstallConfigParamClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index 8dbd66b..f610716 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -70,6 +70,7 @@ struct _OsinfoInstallScript
 /* class */
 struct _OsinfoInstallScriptClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
@@ -77,8 +78,8 @@ struct _OsinfoInstallScriptClass
 
 /**
  * OsinfoPathFormat:
- * OSINFO_PATH_FORMAT_UNIX: Unix/Linux path format, e.g /home/foo/bar.txt
- * OSINFO_PATH_FORMAT_DOS: DOS/Windows path format, e.g \My Documents\bar.txt
+ * @OSINFO_PATH_FORMAT_UNIX: Unix/Linux path format, e.g /home/foo/bar.txt
+ * @OSINFO_PATH_FORMAT_DOS: DOS/Windows path format, e.g \My Documents\bar.txt
  */
 typedef enum {
     OSINFO_PATH_FORMAT_UNIX,
diff --git a/osinfo/osinfo_install_scriptlist.h b/osinfo/osinfo_install_scriptlist.h
index 39544d2..108806a 100644
--- a/osinfo/osinfo_install_scriptlist.h
+++ b/osinfo/osinfo_install_scriptlist.h
@@ -59,6 +59,7 @@ struct _OsinfoInstallScriptList
 /* class */
 struct _OsinfoInstallScriptListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_list.h b/osinfo/osinfo_list.h
index 8fc1202..72e2899 100644
--- a/osinfo/osinfo_list.h
+++ b/osinfo/osinfo_list.h
@@ -55,6 +55,7 @@ struct _OsinfoList
 /* class */
 struct _OsinfoListClass
 {
+    /*< private >*/
     GObjectClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_loader.h b/osinfo/osinfo_loader.h
index 0706f41..530e7ba 100644
--- a/osinfo/osinfo_loader.h
+++ b/osinfo/osinfo_loader.h
@@ -58,6 +58,7 @@ struct _OsinfoLoader
 /* class */
 struct _OsinfoLoaderClass
 {
+    /*< private >*/
     GObjectClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_media.h b/osinfo/osinfo_media.h
index 5982580..ee37905 100644
--- a/osinfo/osinfo_media.h
+++ b/osinfo/osinfo_media.h
@@ -96,6 +96,7 @@ struct _OsinfoMedia
 /* class */
 struct _OsinfoMediaClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_medialist.h b/osinfo/osinfo_medialist.h
index e5cf145..8ad6b66 100644
--- a/osinfo/osinfo_medialist.h
+++ b/osinfo/osinfo_medialist.h
@@ -59,6 +59,7 @@ struct _OsinfoMediaList
 /* class */
 struct _OsinfoMediaListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_os.h b/osinfo/osinfo_os.h
index ae4f0e9..486afb3 100644
--- a/osinfo/osinfo_os.h
+++ b/osinfo/osinfo_os.h
@@ -72,6 +72,7 @@ struct _OsinfoOs
 /* class */
 struct _OsinfoOsClass
 {
+    /*< private >*/
     OsinfoProductClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_oslist.h b/osinfo/osinfo_oslist.h
index 051dce8..9a38ca7 100644
--- a/osinfo/osinfo_oslist.h
+++ b/osinfo/osinfo_oslist.h
@@ -59,6 +59,7 @@ struct _OsinfoOsList
 /* class */
 struct _OsinfoOsListClass
 {
+    /*< private >*/
     OsinfoProductListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_platform.h b/osinfo/osinfo_platform.h
index 0aeb857..fc99bf9 100644
--- a/osinfo/osinfo_platform.h
+++ b/osinfo/osinfo_platform.h
@@ -60,6 +60,7 @@ struct _OsinfoPlatform
 /* class */
 struct _OsinfoPlatformClass
 {
+    /*< private >*/
     OsinfoProductClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_platformlist.h b/osinfo/osinfo_platformlist.h
index eb00274..8628563 100644
--- a/osinfo/osinfo_platformlist.h
+++ b/osinfo/osinfo_platformlist.h
@@ -59,6 +59,7 @@ struct _OsinfoPlatformList
 /* class */
 struct _OsinfoPlatformListClass
 {
+    /*< private >*/
     OsinfoProductListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_product.h b/osinfo/osinfo_product.h
index 57bd29b..daf512a 100644
--- a/osinfo/osinfo_product.h
+++ b/osinfo/osinfo_product.h
@@ -67,6 +67,7 @@ struct _OsinfoProduct
 /* class */
 struct _OsinfoProductClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_productfilter.h b/osinfo/osinfo_productfilter.h
index f192edc..b2c541c 100644
--- a/osinfo/osinfo_productfilter.h
+++ b/osinfo/osinfo_productfilter.h
@@ -55,6 +55,7 @@ struct _OsinfoProductFilter
 /* class */
 struct _OsinfoProductFilterClass
 {
+    /*< private >*/
     OsinfoFilterClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_productlist.h b/osinfo/osinfo_productlist.h
index 68c8482..e722760 100644
--- a/osinfo/osinfo_productlist.h
+++ b/osinfo/osinfo_productlist.h
@@ -59,6 +59,7 @@ struct _OsinfoProductList
 /* class */
 struct _OsinfoProductListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_resources.h b/osinfo/osinfo_resources.h
index 3ffab38..8e1878a 100644
--- a/osinfo/osinfo_resources.h
+++ b/osinfo/osinfo_resources.h
@@ -77,6 +77,7 @@ struct _OsinfoResources
 /* class */
 struct _OsinfoResourcesClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_resourceslist.h b/osinfo/osinfo_resourceslist.h
index 5844a4e..4091dc4 100644
--- a/osinfo/osinfo_resourceslist.h
+++ b/osinfo/osinfo_resourceslist.h
@@ -67,6 +67,7 @@ struct _OsinfoResourcesList
 /* class */
 struct _OsinfoResourcesListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_tree.h b/osinfo/osinfo_tree.h
index 76a92d6..516dec9 100644
--- a/osinfo/osinfo_tree.h
+++ b/osinfo/osinfo_tree.h
@@ -76,6 +76,7 @@ struct _OsinfoTree
 /* class */
 struct _OsinfoTreeClass
 {
+    /*< private >*/
     OsinfoEntityClass parent_class;
 
     /* class members */
diff --git a/osinfo/osinfo_treelist.h b/osinfo/osinfo_treelist.h
index 840b17b..32b72b4 100644
--- a/osinfo/osinfo_treelist.h
+++ b/osinfo/osinfo_treelist.h
@@ -59,6 +59,7 @@ struct _OsinfoTreeList
 /* class */
 struct _OsinfoTreeListClass
 {
+    /*< private >*/
     OsinfoListClass parent_class;
 
     /* class members */
-- 
1.7.8.6




More information about the virt-tools-list mailing list