summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTommi Komulainen <tommi.komulainen@iki.fi>2008-10-22 14:02:02 +0000
committerTommi Komulainen <tko@src.gnome.org>2008-10-22 14:02:02 +0000
commitdc6518128a6d25c97e8e6801961700c15b6d68fa (patch)
treed8312f1df45b2a7e57a609d4e41687cc587a43dd /docs
parent7b171be482d33af3f4a6afa6bf34b433ce70fdb1 (diff)
downloadgobject-introspection-dc6518128a6d25c97e8e6801961700c15b6d68fa.tar.gz
Bug 557405 – Use 'allow-none' consistently
2008-10-22 Tommi Komulainen <tommi.komulainen@iki.fi> * docs/typelib-format.txt: * girepository/ginfo.c (g_arg_info_may_be_null): * girepository/girnode.c (g_ir_node_build_typelib): * girepository/girnode.h (struct _GIrNodeParam): * girepository/girparser.c (start_parameter): * girepository/girwriter.c (function_generate): * girepository/gtypelib.h (ArgBlob): * tests/errors.gir: * tests/function.gir: * tools/generate.c (write_callable_info): Use 'allow-none' consistently throughout svn path=/trunk/; revision=782
Diffstat (limited to 'docs')
-rw-r--r--docs/typelib-format.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/typelib-format.txt b/docs/typelib-format.txt
index a09ab015..0c813ba8 100644
--- a/docs/typelib-format.txt
+++ b/docs/typelib-format.txt
@@ -380,7 +380,7 @@ struct ArgBlob
guint in : 1;
guint out : 1;
guint dipper : 1;
- guint null_ok : 1;
+ guint allow_none : 1;
guint optional : 1;
guint transfer_ownership : 1;
guint transfer_container_ownership : 1;
@@ -403,11 +403,12 @@ out: The parameter is used to return an output of the function.
dipper: The parameter is a pointer to a struct or object that will
receive an output of the function.
-null_ok: Only meaningful for types which are passed as pointers.
+allow_none:
+ Only meaningful for types which are passed as pointers.
For an in parameter, indicates if it is ok to pass NULL in, for
an out parameter, whether it may return NULL. Note that NULL is a
- valid GList and GSList value, thus null_ok will normally be set for
- parameters of these types.
+ valid GList and GSList value, thus allow_none will normally be set
+ for parameters of these types.
optional:
For an out parameter, indicates that NULL may be passed in