summaryrefslogtreecommitdiff
path: root/doc/annotation-glossary.xml
blob: 4a0f8a67898a5ebbe691927b8f097bcf8c2ff907 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?xml version="1.0"?>
<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>

<glossary id="annotation-glossary">
<title>Annotation Glossary</title>
<glossdiv><title>A</title>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-allow-none"/>allow-none</glossterm>
		<glossdef>
			<para>NULL is ok, both for passing and for returning.</para>
		</glossdef>
	</glossentry>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-array"/>array</glossterm>
		<glossdef>
			<para>Parameter points to an array of items.</para>
		</glossdef>
	</glossentry>
</glossdiv>
<glossdiv><title>E</title>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-element-type"/>element-type</glossterm>
		<glossdef>
			<para>Generics and defining elements of containers and arrays.</para>
		</glossdef>
	</glossentry>
</glossdiv>
<glossdiv><title>I</title>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-inout"/>inout</glossterm>
		<glossdef>
			<para>Parameter for input and for returning results. Default is <acronym>transfer full</acronym>.</para>
		</glossdef>
	</glossentry>
</glossdiv>
<glossdiv><title>O</title>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-out"/>out</glossterm>
		<glossdef>
			<para>Parameter for returning results. Default is <acronym>transfer full</acronym>.</para>
		</glossdef>
	</glossentry>
</glossdiv>
<glossdiv><title>T</title>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-transfer full"/>transfer full</glossterm>
		<glossdef>
			<para>Free data after the code is done.</para>
		</glossdef>
	</glossentry>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-type"/>type</glossterm>
		<glossdef>
			<para>Override the parsed C type with given type</para>
		</glossdef>
	</glossentry>
	<glossentry>
		<glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm>
		<glossdef>
			<para>Don't free data after the code is done.</para>
		</glossdef>
	</glossentry>
</glossdiv>
</glossary>