libfprint-docs.xml 2.37 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<?xml version="1.0"?>
<!DOCTYPE book 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'">
]>
<book id="index">
  <bookinfo>
    <title>libfprint Reference Manual</title>
    <releaseinfo>
      <para>This document is the API reference for the libfprint library.</para>
      <para>
        The latest version of libfprint, as well as the latest version of
14
        this API reference, is <ulink role="online-location" url="https://fprint.freedesktop.org/libfprint-dev/">available online</ulink>.
15 16 17 18 19 20 21 22 23 24 25 26
      </para>
    </releaseinfo>
  </bookinfo>

  <part>
    <title>Library Overview</title>
    <xi:include href="intro.xml"/>
    <xi:include href="advanced-topics.xml"/>
    <xi:include href="getting-started.xml"/>
  </part>

  <part>
27
    <title>Library API Documentation</title>
28 29 30 31 32 33
    <xi:include href="xml/events.xml"/>
    <xi:include href="xml/discovery.xml"/>

    <xi:include href="xml/drv.xml"/>
    <xi:include href="xml/dev.xml"/>
    <xi:include href="xml/print_data.xml"/>
34 35
    <!-- FIXME https://bugs.freedesktop.org/show_bug.cgi?id=106550 -->
    <xi:include href="xml/dscv_print.xml"/>
36 37 38 39 40
    <xi:include href="xml/img.xml"/>
  </part>

  <part>
    <title>Writing Drivers</title>
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
    <chapter id="driver-helpers">
      <title>Logging, and async machinery</title>
      <xi:include href="xml/fpi-log.xml"/>
      <xi:include href="xml/fpi-ssm.xml"/>
      <xi:include href="xml/fpi-poll.xml"/>
    </chapter>

    <chapter id="driver-dev">
      <title>Device and driver structures</title>
      <xi:include href="xml/fpi-dev.xml"/>
      <xi:include href="xml/fpi-dev-img.xml"/>
      <xi:include href="xml/fpi-core.xml"/>
      <xi:include href="xml/fpi-core-img.xml"/>
    </chapter>

    <chapter id="driver-img">
      <title>Image manipulation</title>
      <xi:include href="xml/fpi-img.xml"/>
      <xi:include href="xml/fpi-assembling.xml"/>
    </chapter>

62
    <xi:include href="xml/fpi-usb.xml"/>
63 64 65 66 67 68 69 70 71 72 73
  </part>

  <index id="api-index">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>
  <index id="deprecated-api-index" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>
</book>