[gobject-introspection] girepository: Clarify SimpleTypeBlob documentation



commit 7c53ad41b6525811ead53f1f173e556bc9d6cbd4
Author: Philip Chimento <philip chimento gmail com>
Date:   Fri Jan 28 13:22:05 2022 -0800

    girepository: Clarify SimpleTypeBlob documentation
    
    The documentation comment for SimpleTypeBlob seemed to imply that a basic
    type was embedded if the reserved fields were nonzero. After examining the
    code, I believe that was actually due to some words missing, and the
    comment should say that the type is embedded if the fields are zero.

 girepository/gitypelib-internal.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/girepository/gitypelib-internal.h b/girepository/gitypelib-internal.h
index 7fe9128f..e4104089 100644
--- a/girepository/gitypelib-internal.h
+++ b/girepository/gitypelib-internal.h
@@ -378,9 +378,9 @@ union _SimpleTypeBlob
  * references to types.
  *
  * SimpleTypeBlob is divided into two cases; first, if "reserved" and
- * "reserved2", the type tag for a basic type is embedded in the "tag" bits.
- * This allows e.g. GI_TYPE_TAG_UTF8, GI_TYPE_TAG_INT and the like to be
- * embedded directly without taking up extra space.
+ * "reserved2" are both zero, the type tag for a basic type is embedded in the
+ * "tag" bits. This allows e.g. GI_TYPE_TAG_UTF8, GI_TYPE_TAG_INT and the like
+ * to be embedded directly without taking up extra space.
  *
  * References to "interfaces" (objects, interfaces) are more complicated;
  * In this case, the integer is actually an offset into the directory (see


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