summaryrefslogtreecommitdiff
path: root/docs/api/gusb-docs.sgml
blob: 87c27582eb08926358fe0e93d0ec14142bcd6a69 (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
<?xml version="1.0"?>
<!DOCTYPE book 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">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>GUsb Reference Manual</title>
    <releaseinfo>
      for GUsb &version;
    </releaseinfo>
    <authorgroup>
      <author>
        <firstname>Richard</firstname>
        <surname>Hughes</surname>
        <affiliation>
          <address>
            <email>richard@hughsie.com</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>
    <copyright>
      <year>2011</year>
      <holder>Richard Hughes</holder>
    </copyright>
  </bookinfo>

  <reference id="specification">
    <title>GUSB Specification</title>
    <partintro>
      <para>
        GUsb is a GLib wrapper for libusb1.
      </para>
      <para>
        This manual documents features of GUsb.
      </para>
    </partintro>
    <xi:include href="gusb-introduction.xml"/>
  </reference>

  <reference id="libgusb">
    <title>libgusb GObject library</title>
    <partintro>
      <para>
        This part documents GObjects used in libgusb.
      </para>
    </partintro>
    <xi:include href="xml/gusb-context.xml"/>
    <xi:include href="xml/gusb-source.xml"/>
    <xi:include href="xml/gusb-device.xml"/>
    <xi:include href="xml/gusb-device-list.xml"/>
    <xi:include href="xml/gusb-interface.xml"/>
  </reference>

  <reference id="libgusb-helpers">
    <title>libgusb glib helpers</title>
    <partintro>
      <para>
        This part documents helper functions in libgusb.
      </para>
    </partintro>
    <xi:include href="xml/gusb-version.xml"/>
  </reference>

  <reference id="faq">
    <title>Frequently asked questions</title>
    <partintro>
      <para>
        This part has answers to developer frequently asked questions.
      </para>
    </partintro>
    <xi:include href="gusb-faq.xml"/>
  </reference>

</book>