diff options
author | Christoph Reiter <reiter.christoph@gmail.com> | 2018-12-12 09:32:44 +0100 |
---|---|---|
committer | Christoph Reiter <reiter.christoph@gmail.com> | 2018-12-14 11:29:11 +0100 |
commit | 233084070fec59465fbead5c525b11c385be74ed (patch) | |
tree | a2b00c596ac81dd8a5c0caae6a10cba578008d38 /docs | |
parent | 5f5a3ed26814e547ac32b2b0fe83a5a1602074f0 (diff) | |
download | gobject-introspection-233084070fec59465fbead5c525b11c385be74ed.tar.gz |
docs: Remove everything not related to libgirepository and restructure. Fixes #244
The gtk-doc docs were including some bits of overal g-i docs but mostly unfinished
and outdated.
We now have the general docs in sphinx so remove the duplication and make the gtk-docs
just about the libgirepository API and nothing more.
This also renames some titles and fixes some missing links in the struct hierarchy
while at it.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 8 | ||||
-rw-r--r-- | docs/reference/gi-docs.xml | 76 | ||||
-rw-r--r-- | docs/reference/gi-gir-reference.xml | 123 | ||||
-rw-r--r-- | docs/reference/gi-sections.txt | 3 | ||||
-rw-r--r-- | docs/reference/gi-struct-hierarchy.xml | 6 | ||||
-rw-r--r-- | docs/reference/images/overview.png | bin | 112776 -> 0 bytes | |||
-rw-r--r-- | docs/reference/images/overview.svg | 494 | ||||
-rw-r--r-- | docs/reference/meson.build | 4 | ||||
-rw-r--r-- | docs/reference/overview-building.xml | 189 | ||||
-rw-r--r-- | docs/reference/overview-programming.xml | 22 |
10 files changed, 25 insertions, 900 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index ed55e594..ee953bb7 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -57,17 +57,9 @@ IGNORE_HFILES= \ girmodule.h \ girepository-private.h -# Images to copy into HTML directory. -# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES= \ - images/overview.png - # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml content_files= \ - overview-building.xml \ - overview-programming.xml \ - gi-gir-reference.xml \ gi-struct-hierarchy.xml \ version.xml diff --git a/docs/reference/gi-docs.xml b/docs/reference/gi-docs.xml index 352fe7ec..78db99ae 100644 --- a/docs/reference/gi-docs.xml +++ b/docs/reference/gi-docs.xml @@ -5,63 +5,30 @@ <!ENTITY version SYSTEM "xml/version.xml"> ]> <book id="index" lang="en" xmlns:xi="http://www.w3.org/2003/XInclude"> - <title>GObject Introspection Reference Manual</title> + <title>libgirepository API Reference</title> <bookinfo> - <title>GObject Introspection Reference Manual</title> + <title>libgirepository API Reference</title> <releaseinfo> - This document is for GObject Introspection version &version;. + This document is for libgirepository version &version;. The latest version of this documentation can be found on-line at - <ulink type="http" url="http://developer.gnome.org/gi/unstable/">http://developer.gnome.org/gi/unstable/</ulink>. + <ulink type="http" url="https://developer.gnome.org/gi/unstable/">https://developer.gnome.org/gi/unstable/</ulink>. + <para> + For more information on how to build libgirepository, for how to build + bindings with it and for information on GObject Introspection in + general see + <ulink type="http" url="https://gi.readthedocs.io">https://gi.readthedocs.io</ulink>. + </para> </releaseinfo> </bookinfo> - <part id="overview"> - <title>GObject-Introspection Overview</title> - <para> - GObject-Introspection is striving to provide a middleware layer between - (GObject based) C libraries and language bindings. The primary goal of - this project is to minimize duplicated effort in language binding - projects by providing shared metadata files on bound C libraries. - Language bindings can read these metadata files at runtime to learn - how to interface with a bound C library. - </para> + <xi:include href="xml/girepository.xml"/> + <xi:include href="xml/gitypelib.xml" /> + <xi:include href="xml/gicommontypes.xml"/> - <xi:include href="xml/overview-building.xml"/> - <xi:include href="xml/overview-programming.xml"/> - - <para> - The GObject-Introspection package contains of a few different parts: - <itemizedlist> - <listitem> - <para>The GIR XML format - an XML format describing the exported C API including documentation</para> - </listitem> - <listitem> - <para>The GTypelib format - a binary format optimized for fast disk access and low memory usage</para> - </listitem> - <listitem> - <para>g-ir-scanner - parses C source code and gtk-doc comments and generates GIR XML files</para> - </listitem> - <listitem> - <para>g-ir-compiler - compiles GIR XML files into typelibs</para> - </listitem> - <listitem> - <para>libgirepository - library to access typelib from C</para> - </listitem> - </itemizedlist> - </para> - <para>The following illustration shows how the different components fit together:</para> - <inlinegraphic fileref="overview.png" format="PNG"></inlinegraphic> - </part> - - <part id="gi"> - <title>API Reference</title> <chapter> - <title>GIRepository</title> - <xi:include href="xml/girepository.xml"/> + <title>GIBaseInfo</title> <xi:include href="xml/gi-struct-hierarchy.xml"/> - <xi:include href="xml/gicommontypes.xml"/> - <xi:include href="xml/gibaseinfo.xml"/> <xi:include href="xml/gicallableinfo.xml"/> @@ -85,20 +52,15 @@ <xi:include href="xml/givalueinfo.xml"/> </chapter> - <chapter id="gi-typelib"> - <title>GITypelib</title> - <xi:include href="xml/gitypelib.xml" /> - <xi:include href="xml/gitypelib-internal.xml"/> - </chapter> - <chapter> - <title>TODO</title> + <title>FFI Interface</title> <xi:include href="xml/girffi.xml"/> - - <xi:include href="xml/gi-gir-reference.xml"/> </chapter> - </part> + <chapter> + <title>Internals & Typelib Format</title> + <xi:include href="xml/gitypelib-internal.xml"/> + </chapter> <index id="api-index-full"> <title id="index-all">Index</title> diff --git a/docs/reference/gi-gir-reference.xml b/docs/reference/gi-gir-reference.xml deleted file mode 100644 index 04c85662..00000000 --- a/docs/reference/gi-gir-reference.xml +++ /dev/null @@ -1,123 +0,0 @@ -<?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-node">api</link>. - Possible children: callback, - <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>, - field, - method, - property. - <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: field, - method, - property. - <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> diff --git a/docs/reference/gi-sections.txt b/docs/reference/gi-sections.txt index 3fe4bea8..40841438 100644 --- a/docs/reference/gi-sections.txt +++ b/docs/reference/gi-sections.txt @@ -94,6 +94,8 @@ g_base_info_is_deprecated <SUBSECTION Standard> GI_TYPE_BASE_INFO g_base_info_gtype_get_type +<SUBSECTION Private> +GIUnresolvedInfo </SECTION> <SECTION> @@ -140,7 +142,6 @@ g_callable_info_skip_return <SECTION> <FILE>gicommontypes</FILE> GIArgument -GIUnresolvedInfo GITypeTag GIArrayType GI_TYPE_TAG_N_TYPES diff --git a/docs/reference/gi-struct-hierarchy.xml b/docs/reference/gi-struct-hierarchy.xml index fc77c2f8..685f85aa 100644 --- a/docs/reference/gi-struct-hierarchy.xml +++ b/docs/reference/gi-struct-hierarchy.xml @@ -22,19 +22,21 @@ * <link linkend="GIBaseInfo">GIBaseInfo</link> * <link linkend="gi-GICallableInfo">GICallableInfo</link> * <link linkend="gi-GIFunctionInfo">GIFunctionInfo</link> + * <link linkend="gi-GICallbackInfo">GICallbackInfo</link> * <link linkend="gi-GISignalInfo">GISignalInfo</link> * <link linkend="gi-GIVFuncInfo">GIVFuncInfo</link> * <link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> * <link linkend="gi-GIEnumInfo">GIEnumInfo</link> - * <link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link> - * <link linkend="gi-GIObjectInfo">GIObjectInfo</link> * <link linkend="gi-GIStructInfo">GIStructInfo</link> * <link linkend="gi-GIUnionInfo">GIUnionInfo</link> + * <link linkend="gi-GIObjectInfo">GIObjectInfo</link> + * <link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link> * <link linkend="gi-GIArgInfo">GIArgInfo</link> * <link linkend="gi-GIConstantInfo">GIConstantInfo</link> * <link linkend="gi-GIFieldInfo">GIFieldInfo</link> * <link linkend="gi-GIPropertyInfo">GIPropertyInfo</link> * <link linkend="gi-GITypeInfo">GITypeInfo</link> + * <link linkend="gi-GIValueInfo">GIValueInfo</link> </synopsis> </refsynopsisdiv> diff --git a/docs/reference/images/overview.png b/docs/reference/images/overview.png Binary files differdeleted file mode 100644 index b4a12bda..00000000 --- a/docs/reference/images/overview.png +++ /dev/null diff --git a/docs/reference/images/overview.svg b/docs/reference/images/overview.svg deleted file mode 100644 index 6a004f6d..00000000 --- a/docs/reference/images/overview.svg +++ /dev/null @@ -1,494 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!-- Created with Inkscape (http://www.inkscape.org/) --> -<svg - xmlns:dc="http://purl.org/dc/elements/1.1/" - xmlns:cc="http://creativecommons.org/ns#" - xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns="http://www.w3.org/2000/svg" - xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" - xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="744.09448819" - height="1052.3622047" - id="svg2" - sodipodi:version="0.32" - inkscape:version="0.46" - sodipodi:docname="overview.svg" - inkscape:output_extension="org.inkscape.output.svg.inkscape"> - <defs - id="defs4"> - <inkscape:perspective - sodipodi:type="inkscape:persp3d" - inkscape:vp_x="0 : 526.18109 : 1" - inkscape:vp_y="0 : 1000 : 0" - inkscape:vp_z="744.09448 : 526.18109 : 1" - inkscape:persp3d-origin="372.04724 : 350.78739 : 1" - id="perspective10" /> - </defs> - <sodipodi:namedview - id="base" - pagecolor="#ffffff" - bordercolor="#666666" - borderopacity="1.0" - gridtolerance="10000" - guidetolerance="10" - objecttolerance="10" - inkscape:pageopacity="0.0" - inkscape:pageshadow="2" - inkscape:zoom="1.4" - inkscape:cx="370.10718" - inkscape:cy="688.69351" - inkscape:document-units="px" - inkscape:current-layer="layer1" - showgrid="false" - inkscape:window-width="1432" - inkscape:window-height="872" - inkscape:window-x="1440" - inkscape:window-y="25" /> - <metadata - id="metadata7"> - <rdf:RDF> - <cc:Work - rdf:about=""> - <dc:format>image/svg+xml</dc:format> - <dc:type - rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> - </cc:Work> - </rdf:RDF> - </metadata> - <g - inkscape:label="Layer 1" - inkscape:groupmode="layer" - id="layer1"> - <rect - style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - id="rect2383" - width="678.57141" - height="514.28571" - x="29.999998" - y="25.219318" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <path - style="fill:none;fill-rule:evenodd;stroke:#303030;stroke-width:1.02008247;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:4.08032983, 1.02008246;stroke-dashoffset:0;stroke-opacity:0.77586209" - d="M 42.877341,295.93361 L 701.40837,295.93361" - id="path3171" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <rect - style="fill:#bbffff;fill-opacity:1;stroke:#000000;stroke-width:1.06179869;stroke-opacity:0.62780265" - id="rect3185" - width="186.36678" - height="33.509632" - x="67.173752" - y="224.53593" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="76.428574" - y="245.93361" - id="text3187" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3189" - x="76.428574" - y="245.93361">Introspected GType's</tspan></text> - <g - id="g3325" - transform="translate(-66.428571,30.714286)" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"> - <rect - y="102.00188" - x="171.78255" - height="33.577782" - width="109.29207" - id="rect3221" - style="fill:#bbffff;fill-opacity:1;stroke:#000000;stroke-width:0.99365026;stroke-opacity:0.62780265" /> - <text - id="text3223" - y="124.61499" - x="185.23328" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="124.61499" - x="185.23328" - id="tspan3225" - sodipodi:role="line">Sources .c</tspan></text> - </g> - <g - id="g3320" - transform="translate(-66.428571,30.714286)" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"> - <rect - y="145.21617" - x="170.71114" - height="33.577782" - width="109.29207" - id="rect3183" - style="fill:#bbffff;fill-opacity:1;stroke:#000000;stroke-width:0.99365026;stroke-opacity:0.62780265" /> - <text - id="text3227" - y="167.96991" - x="181.77515" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="167.96991" - x="181.77515" - id="tspan3229" - sodipodi:role="line">Headers .h</tspan></text> - </g> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.6243791px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 214.0979,149.31722 L 288.75925,191.83573" - id="path3231" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.48916915px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 254.74458,239.76045 L 288.82684,192.82106" - id="path3235" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <rect - style="fill:#87ffa1;fill-opacity:1;stroke:#000000;stroke-width:1.30141628;stroke-opacity:1" - id="rect3247" - width="208.27" - height="135.41287" - x="289.4364" - y="133.9415" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="295.99329" - y="156.75784" - id="text3249" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - x="295.99329" - y="156.75784" - id="tspan3469">GIR - XML format with</tspan><tspan - sodipodi:role="line" - x="295.99329" - y="176.75784" - id="tspan3495">introspectable metadata</tspan><tspan - sodipodi:role="line" - x="295.99329" - y="196.75784" - id="tspan3471">a language binding need</tspan><tspan - sodipodi:role="line" - x="295.99329" - y="216.75784" - id="tspan3491">function,class,enum,</tspan><tspan - sodipodi:role="line" - x="295.99329" - y="236.75784" - id="tspan3515">docstrings, struct fields</tspan><tspan - sodipodi:role="line" - x="295.99329" - y="256.75784" - id="tspan2561">etc</tspan></text> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="227.14287" - y="107.36218" - id="text3253" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3255" - x="227.14287" - y="107.36218">g-ir-scanner(1)</tspan></text> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="541.42859" - y="107.36218" - id="text3257" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3259" - x="541.42859" - y="107.36218">g-ir-compiler(1)</tspan></text> - <path - style="fill:none;fill-opacity:0.35426007;fill-rule:evenodd;stroke:#000000;stroke-width:1.28129315;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:3.84387917, 3.84387917;stroke-dashoffset:0;stroke-opacity:0.48878922" - d="M 513.92858,92.402021 L 513.92858,282.32233" - id="path3265" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 212.85714,193.79075 L 287.85714,193.79075" - id="path3279" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.68055099px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 499.4176,193.07647 L 534.15382,193.07647" - id="path3281" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <g - id="g3473" - transform="translate(24.285714,13.571429)" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"> - <rect - y="130.21986" - x="510.00055" - height="105.71322" - width="157.85606" - id="rect3277" - style="fill:#b5ff87;fill-opacity:1;stroke:#000000;stroke-width:1.00107861;stroke-opacity:1" /> - <text - id="text3283" - y="153.20482" - x="526.4989" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="153.20482" - x="526.4989" - id="tspan3285" - sodipodi:role="line">Typelib - binary</tspan><tspan - id="tspan3457" - y="173.20482" - x="526.4989" - sodipodi:role="line">format for fast</tspan><tspan - id="tspan3459" - y="193.20482" - x="526.4989" - sodipodi:role="line">disk-access and</tspan><tspan - id="tspan3461" - y="213.20482" - x="526.4989" - sodipodi:role="line">low memory</tspan></text> - </g> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="44.285713" - y="56.647896" - id="text3297" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3299" - x="44.285713" - y="56.647896" - style="font-size:20px;font-weight:bold;-inkscape-font-specification:Bitstream Vera Sans Bold">Build time</tspan></text> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="48.293804" - y="329.10397" - id="text3301" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - x="48.293804" - y="329.10397" - style="font-size:20px;font-weight:bold;-inkscape-font-specification:Bitstream Vera Sans Bold" - id="tspan3305">Runtime</tspan></text> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="244.28571" - y="118.79075" - id="text3312"><tspan - sodipodi:role="line" - id="tspan3314" /></text> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="244.28571" - y="118.79075" - id="text3316"><tspan - sodipodi:role="line" - id="tspan3318" /></text> - <text - xml:space="preserve" - style="font-size:12px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans" - x="67.14286" - y="350.21933" - id="text3342" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3344" - x="67.14286" - y="350.21933" - style="font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:Bitstream Vera Serif;-inkscape-font-specification:Bitstream Vera Serif Italic">How a language binding uses introspection</tspan></text> - <text - xml:space="preserve" - style="font-size:12px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans" - x="66.887283" - y="79.159195" - id="text3346" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3348" - x="66.887283" - y="79.159195" - style="font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:Bitstream Vera Serif;-inkscape-font-specification:Bitstream Vera Serif Italic">How a library enables introspection</tspan></text> - <rect - style="fill:#b5ff87;fill-opacity:1;stroke:#000000;stroke-width:1.0904454;stroke-opacity:1" - id="rect3359" - width="191.33812" - height="103.481" - x="80.402374" - y="385.97882" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="109.08316" - y="422.13339" - id="text3361" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3363" - x="109.08316" - y="422.13339">Typelib - mmap()</tspan><tspan - sodipodi:role="line" - x="109.08316" - y="442.13339" - id="tspan3395">shared between</tspan><tspan - sodipodi:role="line" - x="109.08316" - y="462.13339" - id="tspan3397">processes</tspan></text> - <g - id="g3413" - transform="translate(-30.714286,3.5714286)" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"> - <rect - y="388.51193" - x="366.86404" - height="43.41486" - width="148.41486" - id="rect3376" - style="fill:#ffcf87;fill-opacity:1;stroke:#000000;stroke-width:0.44228357;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:0.48878922" /> - <text - id="text3380" - y="414.63342" - x="383.2746" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="414.63342" - x="383.2746" - id="tspan3382" - sodipodi:role="line">libgirepository</tspan></text> - </g> - <g - id="g3418" - transform="translate(-30,3.5714286)" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"> - <rect - y="445.21933" - x="367.14288" - height="37.142857" - width="147.85715" - id="rect3384" - style="fill:#ffcf87;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:0.48878922" /> - <text - id="text3386" - y="469.75562" - x="423.70425" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - xml:space="preserve"><tspan - y="469.75562" - x="423.70425" - id="tspan3388" - sodipodi:role="line">libffi</tspan></text> - </g> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.82769597px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 272.05671,437.35287 L 335.08615,412.27603" - id="path3399" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.83396173px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 271.62195,443.79905 L 336.51159,469.58806" - id="path3401" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <rect - style="fill:#bbffff;fill-opacity:1;stroke:#000000;stroke-width:0.88915378;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:0.48878922" - id="rect3403" - width="152.96799" - height="41.539417" - x="529.23022" - y="418.02109" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <text - xml:space="preserve" - style="font-size:16px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans" - x="537.24548" - y="443.20486" - id="text3405" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90"><tspan - sodipodi:role="line" - id="tspan3407" - x="537.24548" - y="443.20486">dlopen:ed library</tspan></text> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.21470141px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 484.39306,412.46952 L 529.17837,437.96912" - id="path3409" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - <path - style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1.19193971px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - d="M 485.09597,466.55192 L 529.18975,440.3153" - id="path3411" - inkscape:export-filename="/home/jdahlin/dev/gnome/gobject-introspection/docs/reference/images/overview.png" - inkscape:export-xdpi="90" - inkscape:export-ydpi="90" /> - </g> -</svg> diff --git a/docs/reference/meson.build b/docs/reference/meson.build index b6173116..3d2a5567 100644 --- a/docs/reference/meson.build +++ b/docs/reference/meson.build @@ -22,11 +22,7 @@ gnome.gtkdoc('gi', main_xml: 'gi-docs.xml', dependencies: girepo_dep, src_dir: 'girepository', - html_assets: 'images/overview.png', content_files: [ - 'overview-building.xml', - 'overview-programming.xml', - 'gi-gir-reference.xml', 'gi-struct-hierarchy.xml', ], scan_args: [ diff --git a/docs/reference/overview-building.xml b/docs/reference/overview-building.xml deleted file mode 100644 index 7c843ce3..00000000 --- a/docs/reference/overview-building.xml +++ /dev/null @@ -1,189 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -]> -<refentry id="gi-building"> - <refmeta> - <refentrytitle>Compiling the GObject Introspection package</refentrytitle> - </refmeta> - - <refnamediv> - <refname>Compiling the GObject Introspection Package</refname> - <refpurpose>How to compile GObject Introspection itself</refpurpose> - </refnamediv> - - <refsect1 id="gi-buildtools"> - <title>Building on UNIX</title> - <para> - On UNIX, GObject Introspection uses the standard GNU build system, - using <application>autoconf</application> for package - configuration and resolving portability issues, - <application>automake</application> for building makefiles - that comply with the GNU Coding Standards, and - <application>libtool</application> for building shared - libraries on multiple platforms. The normal sequence for - compiling and installing the GObject Introspection package is thus: - - <literallayout> - <userinput>./configure</userinput> - <userinput>make</userinput> - <userinput>make install</userinput> - </literallayout> - </para> - - <para> - The standard options provided by <application>GNU - autoconf</application> may be passed to the - <command>configure</command> script. Please see the - <application>autoconf</application> documentation or run - <command>./configure --help</command> for information about - the standard options. - </para> - </refsect1> - - <refsect1 id="dependencies"> - <title>Dependencies</title> - <para> - Before you can compile GObject Introspection, you need to have - various other tools and libraries installed on your - system. The tools needed during the build process (as - differentiated from the basic build tools mentioned - <link linkend="gi-buildtools">before</link> are: - </para> - <itemizedlist> - <listitem> - <para> - <ulink url="http://www.freedesktop.org/software/pkgconfig/">pkg-config</ulink> - is a tool for tracking the compilation flags needed for - libraries that are used by the GObjecct Introspection. (For each - library, a small <literal>.pc</literal> text file is - installed in a standard location that contains the compilation - flags needed for that library along with version number - information.) - </para> - </listitem> - <listitem> - <para> - The GObject-Introspection makefiles will mostly work with different - versions of <command>make</command>, however, there tends to be a - few incompatibilities, so the GObject-Introspection team recommends - installing <ulink url="http://www.gnu.org/software/make">GNU - make</ulink> if you don't already have it on your system - and using it. (It may be called <command>gmake</command> - rather than <command>make</command>.) - </para> - </listitem> - </itemizedlist> - <para> - GObject-Introspection depends on a number of libraries and tools - maintained under the umbrella of the GNOME project: - </para> - <itemizedlist> - <listitem> - <para> - The GLib library provides core non-graphical functionality - such as high level data types, Unicode manipulation, and - an object and type system to C programs. It is available - from the <ulink url="ftp.gnome.org/pub/gnome/sources/glib">GNOME - FTP site</ulink> or - <ulink url="http://download.gnome.org/sources/glib/">here</ulink>. - </para> - </listitem> - <listitem> - <para> - TODO: GTK-Doc - </para> - </listitem> - </itemizedlist> - <itemizedlist> - <title>External dependencies</title> - <listitem> - <para> - Python - </para> - </listitem> - <listitem> - <para> - GObject Introspection has an option dependency on the - <ulink url="TODO">libffi</ulink> library. When available, - ... - </para> - </listitem> - <listitem> - <para> - <para> - <ulink url="http://www.cairographics.org">Cairo</ulink> - is a graphics library that supports vector graphics and image - compositing. When available, GObject Introspection uses - Cairo in its unit tests. - </para> - </para> - </listitem> - </itemizedlist> - </refsect1> - - <refsect1 id="extra-configuration-options"> - <title>Extra Configuration Options</title> - - <para> - In addition to the normal options, the - <command>configure</command> script in the GObject Introspection - package supports these additional arguments: - </para> - - <formalpara> - <title><systemitem>--disable-Bsymbolic</systemitem> and - <systemitem>--enable-Bsymbolic</systemitem></title> - - <para> - By default, the GObject Introspection package uses the - -Bsymbolic-functions linker flag to avoid intra-library - PLT jumps. A side-effect of this is that it is no longer - possible to override internal uses of GObject Introspection - functions with <envar>LD_PRELOAD</envar>. Therefore, it may - make sense to turn this feature off in some situations. - The <option>--disable-Bsymbolic</option> option allows - to do that. - </para> - </formalpara> - - <formalpara> - <title><systemitem>--disable-gtk-doc</systemitem> and - <systemitem>--enable-gtk-doc</systemitem></title> - - <para> - By default the <command>configure</command> script will try - to auto-detect whether the - <application>gtk-doc</application> package is installed. - If it is, then it will use it to extract and build the - documentation for the GObject Introspection package. These options - can be used to explicitly control whether - <application>gtk-doc</application> should be - used or not. If it is not used, the distributed, - pre-generated HTML files will be installed instead of - building them on your machine. - </para> - </formalpara> - - <formalpara> - <title><systemitem>--disable-doctool</systemitem> and - <systemitem>--enable-doctool</systemitem></title> - - <para> - TODO - </para> - </formalpara> - - <formalpara> - <title><systemitem>--with-python</systemitem></title> - - <para> - Allows specifying the Python interpreter to use, either as an - absolute path, or as a program name. GObject Introspection can - be built with Python 2 (at least version 2.6) but does not yet - support Python 3. - </para> - </formalpara> - </refsect1> - -</refentry> diff --git a/docs/reference/overview-programming.xml b/docs/reference/overview-programming.xml deleted file mode 100644 index 6511d4b7..00000000 --- a/docs/reference/overview-programming.xml +++ /dev/null @@ -1,22 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -]> -<refentry id="gi-programming"> - <refmeta> - <refentrytitle>Writing introspected libraries</refentrytitle> - </refmeta> - - <refnamediv> - <refname>Writing introspected libraries</refname> - <refpurpose>General considerations when writing introspected libraries</refpurpose> - </refnamediv> - - <refsect1> - <title>TODO</title> - <para> - ... - </para> - </refsect1> - -</refentry> |