diff options
| author | Corentin Noël <corentin.noel@collabora.com> | 2023-02-09 15:25:42 +0100 |
|---|---|---|
| committer | Emmanuele Bassi <ebassi@gmail.com> | 2023-02-13 23:13:31 +0000 |
| commit | 9330cf48438818aad951c43f7b23ff27ad7d8c30 (patch) | |
| tree | 3c8db313a3c019214b2a2893551b7397ef50cba5 | |
| parent | ac5b6bdfa818bd82d888341a1ef4355cd73f77a0 (diff) | |
| download | gobject-introspection-9330cf48438818aad951c43f7b23ff27ad7d8c30.tar.gz | |
docs: Be more specific on error out cases
Add a disambiguation of what to return and do with the out values in case an
error is thrown.
| -rw-r--r-- | docs/website/annotations/giannotations.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/website/annotations/giannotations.rst b/docs/website/annotations/giannotations.rst index 696f5b06..8769132a 100644 --- a/docs/website/annotations/giannotations.rst +++ b/docs/website/annotations/giannotations.rst @@ -223,7 +223,7 @@ Type signature * - ``(nullable)`` - parameters, return value - Indicates that ``NULL`` may be a valid value for a parameter - (in, out, inout), or return value (though note that return values which + (in, out, inout), or return value (though note that return and out values which are only ``NULL`` when throwing an error should not be annotated as ``(nullable)``). - :commit:`1.42 <1459ff3e>` @@ -681,6 +681,8 @@ parameter. An example which demonstrates an (optional) parameter: an (out) parameter where the caller can pass NULL if they don’t want to receive the (out) value. +Note that if the GError is returned set, the value of contents and length might +be unspecified and should therefore not be used or freed. :: |