[virt-tools-list] [libosinfo 1/2] Fix GObject property gtk-doc name

Christophe Fergeau cfergeau at redhat.com
Thu Dec 13 11:41:07 UTC 2012


They must be described as ClassName:property-name: or gtk-doc
won't pick them up. There were some files where '::' was used instead
of ':' as the class name/property name separator.
---
 osinfo/osinfo_media.c     | 22 +++++++++++-----------
 osinfo/osinfo_product.c   | 12 ++++++------
 osinfo/osinfo_resources.c | 10 +++++-----
 osinfo/osinfo_tree.c      | 18 +++++++++---------
 4 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index ffc37b7..a025545 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -328,7 +328,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_type_class_add_private (klass, sizeof (OsinfoMediaPrivate));
 
     /**
-     * OsinfoMedia::architecture:
+     * OsinfoMedia:architecture:
      *
      * The target hardware architecture of this media.
      */
@@ -341,7 +341,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_ARCHITECTURE, pspec);
 
     /**
-     * OsinfoMedia::url:
+     * OsinfoMedia:url:
      *
      * The URL to this media.
      */
@@ -354,7 +354,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_URL, pspec);
 
     /**
-     * OsinfoMedia::volume-id:
+     * OsinfoMedia:volume-id:
      *
      * Expected volume ID (regular expression) for ISO9660 image/device.
      */
@@ -367,7 +367,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_VOLUME_ID, pspec);
 
     /**
-     * OsinfoMedia::publisher-id:
+     * OsinfoMedia:publisher-id:
      *
      * Expected publisher ID (regular expression) for ISO9660 image/device.
      */
@@ -380,7 +380,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_PUBLISHER_ID, pspec);
 
     /**
-     * OsinfoMedia::application-id:
+     * OsinfoMedia:application-id:
      *
      * Expected application ID (regular expression) for ISO9660 image/device.
      */
@@ -393,7 +393,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_APPLICATION_ID, pspec);
 
     /**
-     * OsinfoMedia::system-id:
+     * OsinfoMedia:system-id:
      *
      * Expected system ID (regular expression) for ISO9660 image/device.
      */
@@ -406,7 +406,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_SYSTEM_ID, pspec);
 
     /**
-     * OsinfoMedia::kernel-path:
+     * OsinfoMedia:kernel-path:
      *
      * The path to the kernel image in the install tree.
      */
@@ -419,7 +419,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_KERNEL_PATH, pspec);
 
     /**
-     * OsinfoMedia::initrd-path:
+     * OsinfoMedia:initrd-path:
      *
      * The path to the initrd image in the install tree.
      */
@@ -432,7 +432,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_INITRD_PATH, pspec);
 
     /**
-     * OsinfoMedia::installer:
+     * OsinfoMedia:installer:
      *
      * Whether media provides a installer for an OS.
      */
@@ -445,7 +445,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_INSTALLER, pspec);
 
     /**
-     * OsinfoMedia::live:
+     * OsinfoMedia:live:
      *
      * Whether media can boot directly an OS without any installations.
      */
@@ -458,7 +458,7 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
     g_object_class_install_property (g_klass, PROP_LIVE, pspec);
 
     /**
-     * OsinfoMedia::installer-reboots:
+     * OsinfoMedia:installer-reboots:
      *
      * If media is an installer, this property indicates the number of reboots
      * the installer takes before installation is complete.
diff --git a/osinfo/osinfo_product.c b/osinfo/osinfo_product.c
index bf3c049..2e0ff5d 100644
--- a/osinfo/osinfo_product.c
+++ b/osinfo/osinfo_product.c
@@ -156,7 +156,7 @@ osinfo_product_class_init (OsinfoProductClass *klass)
     g_type_class_add_private (klass, sizeof (OsinfoProductPrivate));
 
     /**
-     * OsinfoProduct::name:
+     * OsinfoProduct:name:
      *
      * The name of this product.
      */
@@ -171,7 +171,7 @@ osinfo_product_class_init (OsinfoProductClass *klass)
     g_object_class_install_property (g_klass, PROP_NAME, pspec);
 
     /**
-     * OsinfoProduct::short-id:
+     * OsinfoProduct:short-id:
      *
      * The short ID of this product.
      */
@@ -186,7 +186,7 @@ osinfo_product_class_init (OsinfoProductClass *klass)
     g_object_class_install_property (g_klass, PROP_SHORT_ID, pspec);
 
     /**
-     * OsinfoProduct::vendor:
+     * OsinfoProduct:vendor:
      *
      * The Vendor of this product.
      */
@@ -201,7 +201,7 @@ osinfo_product_class_init (OsinfoProductClass *klass)
     g_object_class_install_property (g_klass, PROP_VENDOR, pspec);
 
     /**
-     * OsinfoProduct::version:
+     * OsinfoProduct:version:
      *
      * The version of the product.
      */
@@ -216,7 +216,7 @@ osinfo_product_class_init (OsinfoProductClass *klass)
     g_object_class_install_property (g_klass, PROP_VERSION, pspec);
 
     /**
-     * OsinfoProduct::codename:
+     * OsinfoProduct:codename:
      *
      * The codename of this product.
      */
@@ -231,7 +231,7 @@ osinfo_product_class_init (OsinfoProductClass *klass)
     g_object_class_install_property (g_klass, PROP_NAME, pspec);
 
     /**
-     * OsinfoProduct::logo:
+     * OsinfoProduct:logo:
      *
      * The URI of the logo of the product.
      */
diff --git a/osinfo/osinfo_resources.c b/osinfo/osinfo_resources.c
index cfd2340..64b27a1 100644
--- a/osinfo/osinfo_resources.c
+++ b/osinfo/osinfo_resources.c
@@ -161,7 +161,7 @@ osinfo_resources_class_init (OsinfoResourcesClass *klass)
     g_type_class_add_private (klass, sizeof (OsinfoResourcesPrivate));
 
     /**
-     * OsinfoResources::architecture:
+     * OsinfoResources:architecture:
      *
      * The target hardware architecture to which these resources applies.
      */
@@ -179,7 +179,7 @@ osinfo_resources_class_init (OsinfoResourcesClass *klass)
                                      pspec);
 
     /**
-     * OsinfoResources::cpu:
+     * OsinfoResources:cpu:
      *
      * The CPU frequency in hertz (Hz).
      */
@@ -198,7 +198,7 @@ osinfo_resources_class_init (OsinfoResourcesClass *klass)
                                      pspec);
 
     /**
-     * OsinfoResources::n-cpus:
+     * OsinfoResources:n-cpus:
      *
      * The number of CPUs.
      */
@@ -217,7 +217,7 @@ osinfo_resources_class_init (OsinfoResourcesClass *klass)
                                      pspec);
 
     /**
-     * OsinfoResources::ram:
+     * OsinfoResources:ram:
      *
      * The amount of Random Access Memory (RAM) in bytes.
      */
@@ -236,7 +236,7 @@ osinfo_resources_class_init (OsinfoResourcesClass *klass)
                                      pspec);
 
     /**
-     * OsinfoResources::storage:
+     * OsinfoResources:storage:
      *
      * The amount of storage space in bytes.
      */
diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index b8a8645..9575a8d 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -268,7 +268,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_type_class_add_private(klass, sizeof(OsinfoTreePrivate));
 
     /**
-     * OsinfoTree::architecture:
+     * OsinfoTree:architecture:
      *
      * The target hardware architecture of this tree.
      */
@@ -283,7 +283,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_ARCHITECTURE, pspec);
 
     /**
-     * OsinfoTree::url:
+     * OsinfoTree:url:
      *
      * The URL to this tree.
      */
@@ -298,7 +298,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_URL, pspec);
 
     /**
-     * OsinfoTree::volume-id:
+     * OsinfoTree:volume-id:
      *
      * Expected volume ID (regular expression) for ISO9660 image/device.
      */
@@ -313,7 +313,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_TREEINFO_FAMILY, pspec);
 
     /**
-     * OsinfoTree::publisher-id:
+     * OsinfoTree:publisher-id:
      *
      * Expected publisher ID (regular expression) for ISO9660 image/device.
      */
@@ -328,7 +328,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_TREEINFO_VARIANT, pspec);
 
     /**
-     * OsinfoTree::application-id:
+     * OsinfoTree:application-id:
      *
      * Expected application ID (regular expression) for ISO9660 image/device.
      */
@@ -343,7 +343,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_TREEINFO_VERSION, pspec);
 
     /**
-     * OsinfoTree::system-id:
+     * OsinfoTree:system-id:
      *
      * Expected system ID (regular expression) for ISO9660 image/device.
      */
@@ -358,7 +358,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_TREEINFO_ARCH, pspec);
 
     /**
-     * OsinfoTree::kernel-path:
+     * OsinfoTree:kernel-path:
      *
      * The path to the kernel image in the install tree.
      */
@@ -373,7 +373,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_KERNEL_PATH, pspec);
 
     /**
-     * OsinfoTree::initrd-path:
+     * OsinfoTree:initrd-path:
      *
      * The path to the initrd image in the install tree.
      */
@@ -388,7 +388,7 @@ osinfo_tree_class_init(OsinfoTreeClass *klass)
     g_object_class_install_property(g_klass, PROP_INITRD_PATH, pspec);
 
     /**
-     * OsinfoTree::boot-iso-path:
+     * OsinfoTree:boot-iso-path:
      *
      * The path to the boot ISO in the install tree
      */
-- 
1.8.0.1




More information about the virt-tools-list mailing list