File: libfeedback-docs.xml

package info (click to toggle)
feedbackd 0.0.0%2Bgit20210125-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 636 kB
  • sloc: ansic: 4,567; xml: 348; sh: 23; makefile: 17; python: 14
file content (68 lines) | stat: -rw-r--r-- 2,030 bytes parent folder | download
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
<?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'">
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<book id="index">
  <bookinfo>
    <title>&package_name; Reference Manual</title>
    <releaseinfo>
      <para>This document is the API reference for &package_name; &package_version;</para>
      <para>
        <ulink type="http" url="&package_url;">Libfeedback</ulink> is a library to trigger
        feedback (such as haptic feedback) via events sent by your application.
      </para>
      <para>
        If you find any issues in this API reference, please report it using
        <ulink type="http" url="&package_bugreport;">the bugtracker</ulink>.
      </para>
    </releaseinfo>

    <copyright>
      <year>2020</year>
      <holder>Purism SPC</holder>
    </copyright>
  </bookinfo>

  <xi:include href="overview.xml"/>

  <part>
  <title>API Reference</title>

  <chapter id="core-api">
    <title>Core API</title>
    <xi:include href="xml/libfeedback.xml"/>
    <xi:include href="xml/lfb-event.xml"/>
  </chapter>

  <chapter id="low-level-api">
    <title>Low level api</title>
    <xi:include href="xml/lfb-gdbus.xml"/>
    <xi:include href="xml/lfb-names.xml"/>
  </chapter>

  <chapter id="dbus-interface">
    <title>DBus Interface</title>
    <xi:include href="../data/libfeedback-org.sigxcpu.Feedback.xml"/>
  </chapter>
  </part>
  
  <chapter id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

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

  <index id="annotations-glossary">
  <title>Annotations glossary</title>
  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
  </index>

</book>