summaryrefslogtreecommitdiff
path: root/docs/reference/gi-overview.xml
blob: 0943b8e526ce342431649ce1aef1e0dcbfb0a7a9 (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
<?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-overview">
<refmeta>
  <refentrytitle role="top_of_page" id="gi-overview.top_of_page">Introspection Overview</refentrytitle>
  <manvolnum>3</manvolnum>
  <refmiscinfo>GI Library</refmiscinfo>
</refmeta>
<refnamediv>
  <refname>Overview</refname>
  <refpurpose>General overview of introspection</refpurpose>
</refnamediv>

<refsynopsisdiv>
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>A quick overview how the different components fits together:</para>

<inlinegraphic fileref="overview.png" format="PNG"></inlinegraphic>

</refsynopsisdiv>

</refentry>