[libgudev/bilelmoussaoui/gi-docgen: 3/6] docs: Change private structs documentation format




commit 58fc33f3579f6469dc75662f89335e63eeff7f08
Author: Bilal Elmoussaoui <belmouss redhat com>
Date:   Sat Feb 5 13:07:24 2022 +0100

    docs: Change private structs documentation format
    
    Otherwise it confuses g-ir-scanner while looking for the type docs

 gudev/gudevclient.h     | 6 +-----
 gudev/gudevdevice.h     | 6 +-----
 gudev/gudevenumerator.h | 8 +-------
 3 files changed, 3 insertions(+), 17 deletions(-)
---
diff --git a/gudev/gudevclient.h b/gudev/gudevclient.h
index 329f22d..cdb76ac 100644
--- a/gudev/gudevclient.h
+++ b/gudev/gudevclient.h
@@ -29,11 +29,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (GUdevClient, g_object_unref)
 typedef struct _GUdevClientClass   GUdevClientClass;
 typedef struct _GUdevClientPrivate GUdevClientPrivate;
 
-/**
- * GUdevClient:
- *
- * The #GUdevClient struct is opaque and should not be accessed directly.
- */
+// The #GUdevClient struct is opaque and should not be accessed directly.
 struct _GUdevClient
 {
   GObject              parent;
diff --git a/gudev/gudevdevice.h b/gudev/gudevdevice.h
index 69ecc0a..696ea07 100644
--- a/gudev/gudevdevice.h
+++ b/gudev/gudevdevice.h
@@ -29,11 +29,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (GUdevDevice, g_object_unref)
 typedef struct _GUdevDeviceClass   GUdevDeviceClass;
 typedef struct _GUdevDevicePrivate GUdevDevicePrivate;
 
-/**
- * GUdevDevice:
- *
- * The #GUdevDevice struct is opaque and should not be accessed directly.
- */
+// The #GUdevDevice struct is opaque and should not be accessed directly.
 struct _GUdevDevice
 {
   GObject             parent;
diff --git a/gudev/gudevenumerator.h b/gudev/gudevenumerator.h
index e0838ee..ff4a83f 100644
--- a/gudev/gudevenumerator.h
+++ b/gudev/gudevenumerator.h
@@ -29,13 +29,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (GUdevEnumerator, g_object_unref)
 typedef struct _GUdevEnumeratorClass   GUdevEnumeratorClass;
 typedef struct _GUdevEnumeratorPrivate GUdevEnumeratorPrivate;
 
-/**
- * GUdevEnumerator:
- *
- * The #GUdevEnumerator struct is opaque and should not be accessed directly.
- *
- * Since: 165
- */
+// The #GUdevEnumerator struct is opaque and should not be accessed directly.
 struct _GUdevEnumerator
 {
   GObject              parent;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]