summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2022-02-13 14:27:09 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2022-02-13 14:27:09 +0000
commit4cf6839c268724e1ee5bab746fee4eb67ea5f933 (patch)
treea9c139a622fbd43a522343fec75dc3a5f12c5e19
parent549c53f3d4b7cfeed200363a4195d407d8ed64b7 (diff)
downloadgobject-introspection-4cf6839c268724e1ee5bab746fee4eb67ea5f933.tar.gz
docs: Reformat a long description
-rw-r--r--girepository/gitypelib-internal.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/girepository/gitypelib-internal.h b/girepository/gitypelib-internal.h
index a2835f83..09af067e 100644
--- a/girepository/gitypelib-internal.h
+++ b/girepository/gitypelib-internal.h
@@ -37,6 +37,7 @@ G_BEGIN_DECLS
*
* The "typelib" is a binary, readonly, memory-mappable database
* containing reflective information about a GObject library.
+ *
* What the typelib describes and the types used are the same for every
* platform so, apart the endianness of its scalar values, the typelib
* database must be considered architecture-independent.
@@ -45,6 +46,7 @@ G_BEGIN_DECLS
* format.
*
* Some of the differences to XPCOM include:
+ *
* - Type information is stored not quite as compactly (XPCOM stores it inline
* in function descriptions in variable-sized blobs of 1 to n bytes. We store
* 16 bits of type information for each parameter, which is enough to encode
@@ -57,6 +59,7 @@ G_BEGIN_DECLS
*
* The typelib has the following general format:
*
+ * |[<!-- language="C" -->
* typelib ::= header, section-index, directory, blobs, attributes, attributedata
*
* directory ::= list of entries
@@ -65,6 +68,7 @@ G_BEGIN_DECLS
* blob ::= function|callback|struct|boxed|enum|flags|object|interface|constant|union
* attribute ::= offset, key, value
* attributedata ::= string data for attributes
+ * ]|
*
* Details
*