diff options
-rw-r--r-- | docs/reference/gi-docs.sgml | 2 | ||||
-rw-r--r-- | docs/reference/gi-gir-reference.xml | 114 |
2 files changed, 116 insertions, 0 deletions
diff --git a/docs/reference/gi-docs.sgml b/docs/reference/gi-docs.sgml index dc28eba4..864a0f0c 100644 --- a/docs/reference/gi-docs.sgml +++ b/docs/reference/gi-docs.sgml @@ -63,4 +63,6 @@ Bla bla bla bla bla &g-ir-generator; </chapter> --> + + <xi:include href="xml/annotation-glossary.xml" /> </book> diff --git a/docs/reference/gi-gir-reference.xml b/docs/reference/gi-gir-reference.xml new file mode 100644 index 00000000..8d19112e --- /dev/null +++ b/docs/reference/gi-gir-reference.xml @@ -0,0 +1,114 @@ +<chapter id="gi-gir-reference"> + + <title>The GIR XML format</title> + + <para> + This chapter describes the GIR XML markup format. + </para> + + <refsect2 id="gi-gir-api"> + <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> + +</chapter> + |