summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Chimento <philip.chimento@gmail.com>2022-01-28 13:22:05 -0800
committerEmmanuele Bassi <ebassi@gmail.com>2022-02-13 12:25:18 +0000
commit7c53ad41b6525811ead53f1f173e556bc9d6cbd4 (patch)
tree4c9673fec442c851e41500349a8bae39e4416d1a
parent37b1f4dad7a495d45fe93d0849e02e59372f9700 (diff)
downloadgobject-introspection-7c53ad41b6525811ead53f1f173e556bc9d6cbd4.tar.gz
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.
-rw-r--r--girepository/gitypelib-internal.h6
1 files 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