blob: 38604d037317e1bcd64876c3eea15205115d58c9 (
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="gi-gir-reference">
<refmeta>
<refentrytitle role="top_of_page" id="gi-gir-reference.top_of_page">The GIR XML format</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>The GIR XML format</refmiscinfo>
</refmeta>
<refnamediv>
<refname>The GIR XML format</refname>
<refpurpose>The GIR XML format</refpurpose>
</refnamediv>
<para>
This chapter describes the GIR XML markup format. This describes exported C
API, including documentation. It may contain installation-specific data,
such as library filenames which may differ between platforms.
</para>
<refsect2 id="gi-gir-api-node">
<title><emphasis>api</emphasis> node</title>
The root node of all GIR documents is the api node.
Possible children: <link linkend="gi-gir-namespace">namespace</link>.
<example>
<title>A GIR fragment showing an api node</title>
<programlisting><![CDATA[
<api version="1.0">
<namespace/>
</api>]]></programlisting>
</example>
</refsect2>
<refsect2 id="gi-gir-namespace">
<title><emphasis>namespace</emphasis> node</title>
Parent node: <link linkend="gi-gir-api">api</link>.
Possible children: <link linkend="gi-gir-callback">callback</link>,
<link linkend="gi-gir-class">class</link>,
<link linkend="gi-gir-function">function</link>.
<link linkend="gi-gir-interface">interface</link>.
<example>
<title>A GIR fragment showing an namespace node</title>
<programlisting><![CDATA[
<api version="1.0">
<namespace="Gtk">
<class/>
<function/>
</namespace>
</api>]]></programlisting>
</example>
</refsect2>
<refsect2 id="gi-gir-class">
<title><emphasis>class</emphasis> node</title>
Parent node: <link linkend="gi-gir-namespace">namespace</link>.
Possible children: <link linkend="gi-gir-class">constructor</link>,
<link linkend="gi-gir-field">field</link>,
<link linkend="gi-gir-method">method</link>,
<link linkend="gi-gir-property">property</link>.
<example>
<title>A GIR fragment showing an class node</title>
<programlisting><![CDATA[
<api version="1.0">
<namespace="Gtk">
<class name="Widget">
<constructor/>
<field/>
<method/>
<property/>
<class>
</namespace>
</api>]]></programlisting>
</example>
</refsect2>
<refsect2 id="gi-gir-interface">
<title><emphasis>interface</emphasis> node</title>
Parent node: <link linkend="gi-gir-namespace">namespace</link>.
Possible children: <link linkend="gi-gir-field">field</link>,
<link linkend="gi-gir-method">method</link>,
<link linkend="gi-gir-property">property</link>.
<example>
<title>A GIR fragment showing an interface node</title>
<programlisting><![CDATA[
<api version="1.0">
<namespace="Gtk">
<interface name="Buildable">
<field/>
<method/>
<property/>
<interface>
</namespace>
</api>]]></programlisting>
</example>
</refsect2>
<refsect2 id="gi-gir-function">
<title><emphasis>function</emphasis> node</title>
Parent node: <link linkend="gi-gir-namespace">namespace</link>.
<example>
<title>A GIR fragment showing an function node</title>
<programlisting><![CDATA[
<api version="1.0">
<namespace="Gtk">
<function name="init">
</function>
</namespace>
</api>]]></programlisting>
</example>
</refsect2>
</refentry>
|
