depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
libfprint/doc/libfprint-docs.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

78 lines
2.5 KiB
XML
Raw Normal View History

doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
<?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
doc: Update more website links
2018-06-18 10:44:39 +00:00
this API reference, is <ulink role="online-location" url="https://fprint.freedesktop.org/libfprint-dev/">available online</ulink>.
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</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>
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
<title>Library API Documentation</title>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<xi:include href="xml/fp-context.xml"/>
<xi:include href="xml/fp-device.xml"/>
<xi:include href="xml/fp-image-device.xml"/>
sdcp: Add SDCP base class This adds a base class for SDCP devices. Not all functionality has been fully tested, in particular the code to verify the model certificate is most likely broken or incomplete. One problem there is that there is no code to find the root CA to trust. See: #257
2020-05-11 14:17:03 +00:00
<xi:include href="xml/fp-sdcp-device.xml"/>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<xi:include href="xml/fp-print.xml"/>
<xi:include href="xml/fp-image.xml"/>
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</part>
<part>
<title>Writing Drivers</title>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<chapter id="driver-dev">
<title>Device methods for drivers</title>
<xi:include href="xml/fpi-device.xml"/>
<xi:include href="xml/fpi-image-device.xml"/>
sdcp: Add SDCP base class This adds a base class for SDCP devices. Not all functionality has been fully tested, in particular the code to verify the model certificate is most likely broken or incomplete. One problem there is that there is no code to find the root CA to trust. See: #257
2020-05-11 14:17:03 +00:00
<xi:include href="xml/fpi-sdcp-device.xml"/>
doc: Split driver docs into chapters
2018-11-09 14:32:17 +00:00
</chapter>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<chapter id="driver-helpers">
<title>USB and State Machine helpers</title>
<xi:include href="xml/fpi-usb-transfer.xml"/>
<xi:include href="xml/fpi-ssm.xml"/>
<xi:include href="xml/fpi-log.xml"/>
doc: Split driver docs into chapters
2018-11-09 14:32:17 +00:00
</chapter>
<chapter id="driver-img">
<title>Image manipulation</title>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<xi:include href="xml/fpi-image.xml"/>
doc: Split driver docs into chapters
2018-11-09 14:32:17 +00:00
<xi:include href="xml/fpi-assembling.xml"/>
</chapter>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<chapter id="driver-print">
<title>Print handling</title>
<xi:include href="xml/fpi-print.xml"/>
</chapter>
<chapter id="driver-misc">
<title>Listing drivers</title>
<xi:include href="xml/fpi-context.xml"/>
</chapter>
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</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>
Reference in a new issue Copy permalink