summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2022-10-29 18:27:25 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2023-01-08 14:51:55 +0000
commitce8c37d3d6665903da5cf3a6ce5fdbfb442e6e3a (patch)
tree93918a77a809d7737a78efe1d21949bfe0eceb7e
parent168da22eccacc0627fd7a9dd7420f6972f76586f (diff)
downloadgobject-introspection-ce8c37d3d6665903da5cf3a6ce5fdbfb442e6e3a.tar.gz
Document the newly added attributes
Add the (copy-func) and (free-func) annotations to the documentation, and the copy-function and free-function attributes to the GIR schema.
-rw-r--r--docs/gir-1.2.rnc8
-rw-r--r--docs/website/annotations/giannotations.rst8
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/gir-1.2.rnc b/docs/gir-1.2.rnc
index 5182f7cb..b7960ffa 100644
--- a/docs/gir-1.2.rnc
+++ b/docs/gir-1.2.rnc
@@ -228,6 +228,10 @@ grammar {
attribute foreign { "0" | "1" }?,
## Name of the GObject compatible gtype this record represents. If empty, this record will be hidden from generated public APIs.
attribute glib:is-gtype-struct-for { xsd:string }?,
+ ## Name of the function used to copy the record
+ attribute copy-function { xsd:string }?,
+ ## Name of the function used to free the record
+ attribute free-function { xsd:string }?,
# Other elements a record can contain
# mandatory
@@ -636,6 +640,10 @@ grammar {
attribute glib:type-name { xsd:string }?,
## function to retrieve the GObject compatible type of the element
attribute glib:get-type { xsd:string }?,
+ ## Name of the function used to copy the union
+ attribute copy-function { xsd:string }?,
+ ## Name of the function used to free the union
+ attribute free-function { xsd:string }?,
(Info.elements
& Field*
diff --git a/docs/website/annotations/giannotations.rst b/docs/website/annotations/giannotations.rst
index 8099bd5b..696f5b06 100644
--- a/docs/website/annotations/giannotations.rst
+++ b/docs/website/annotations/giannotations.rst
@@ -199,6 +199,14 @@ Support for non-GObject fundamental objects
- ``FUNC`` is the function used to convert from a struct to a GValue,
must be a GTypeInstance
-
+ * - ``(copy-func FUNC)``
+ - identifier
+ - ``FUNC`` is the function used to copy a struct or a union
+ - 1.76
+ * - ``(free-func FUNC)``
+ - identifier
+ - ``FUNC`` is the function used to free a struct or a union
+ - 1.76
Type signature