[gtk-doc] mkdb: add missing instospection annotations
- From: Dieter Verfaillie <dieterv src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] mkdb: add missing instospection annotations
- Date: Tue, 29 Oct 2013 19:57:11 +0000 (UTC)
commit 7442cd934663ea301c9a205f519ca1d83b6ba0a7
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date: Tue Oct 22 09:03:35 2013 +0200
mkdb: add missing instospection annotations
gtkdoc-mkdb.in | 24 ++++++++++++++++++------
1 files changed, 18 insertions(+), 6 deletions(-)
---
diff --git a/gtkdoc-mkdb.in b/gtkdoc-mkdb.in
index eb11093..e448ed7 100755
--- a/gtkdoc-mkdb.in
+++ b/gtkdoc-mkdb.in
@@ -304,27 +304,39 @@ my %AnnotationsUsed;
my %AnnotationDefinition = (
'allow-none' => "NULL is ok, both for passing and for returning.",
'array' => "Parameter points to an array of items.",
- 'attribute' => "Free-form custom annotation.",
+ 'attribute' => "Deprecated free-form custom annotation, replaced by (attributes) annotation.",
+ 'attributes' => "Free-form key-value pairs.",
'closure' => "This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.",
+ 'constructor' => "This symbol is a constructor, not a static method.",
+ 'destroy' => "This parameter is a 'destroy_data', for callbacks.",
'default' => "Default parameter value (for in case the <acronym>shadows</acronym>-to function has less
parameters).",
'element-type' => "Generics and defining elements of containers and arrays.",
'error-domains' => "Typed errors. Similar to throws in Java.",
+ 'foreign' => "This is a foreign struct.",
+ 'get-value-func' => "The specified function is used to convert a struct from a GValue, must be a
GTypeInstance.",
'in' => "Parameter for input. Default is <acronym>transfer none</acronym>.",
'inout' => "Parameter for input and for returning results. Default is <acronym>transfer full</acronym>.",
'in-out' => "Parameter for input and for returning results. Default is <acronym>transfer
full</acronym>.",
+ 'method' => "This is a method",
'not-error' => "A GError parameter is not to be handled like a normal GError.",
'out' => "Parameter for returning results. Default is <acronym>transfer full</acronym>.",
'out caller-allocates' => "Out parameter, where caller must allocate storage.",
'out callee-allocates' => "Out parameter, where caller must allocate storage.",
- 'transfer container' => "Free data container after the code is done.",
- 'transfer floating' => "Alias for <acronym>transfer none</acronym>, used for objects with floating
refs.",
- 'transfer full' => "Free data after the code is done.",
- 'transfer none' => "Don't free data after the code is done.",
+ 'ref-func' => "The specified function is used to ref a struct, must be a GTypeInstance.",
+ 'rename-to' => "Rename the original symbol's name to SYMBOL.",
'scope call' => "The callback is valid only during the call to the method.",
'scope async' => "The callback is valid until first called.",
'scope notified' => "The callback is valid until the GDestroyNotify argument is called.",
+ 'set-value-func' => "The specified function is used to convert from a struct to a GValue, must be a
GTypeInstance.",
'skip' => "Exposed in C code, not necessarily available in other languages.",
- 'type' => "Override the parsed C type with given type."
+ 'transfer container' => "Free data container after the code is done.",
+ 'transfer floating' => "Alias for <acronym>transfer none</acronym>, used for objects with floating
refs.",
+ 'transfer full' => "Free data after the code is done.",
+ 'transfer none' => "Don't free data after the code is done.",
+ 'type' => "Override the parsed C type with given type.",
+ 'unref-func' => "The specified function is used to unref a struct, must be a GTypeInstance.",
+ 'virtual' => "This is the invoker for a virtual method.",
+ 'value' => "The specified value overrides the evaluated value of the constant."
);
# Create the root DocBook output directory if it doens't exist.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]