depau/Purism-Calls
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/calls.git synced 2024-12-04 20:07:36 +00:00
Code Issues Releases Wiki Activity

doc: Include API reference for all core sources

Browse source 
While not every class or interface is properly documented and annotated yet,
adding them to the docs should still be valuable.

Additionally it is a good reminder for ourselves to add some proper description
because things like missing a annotated class description really stand out
currently.
This commit is contained in:
Evangelos Ribeiro Tzaras 2022-02-06 02:28:37 +01:00
parent 3f2481bda9
commit 20271fc2bd
1 changed files with 74 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
doc/calls-docs.xml
View file

@ -27,17 +27,80 @@
</copyright>
</bookinfo>
<chapter id="provider-abstraction">
<title>Provider abstraction</title>
<xi:include href="xml/calls-message-source.xml"/>
<xi:include href="xml/calls-provider.xml"/>
<xi:include href="xml/calls-origin.xml"/>
<xi:include href="xml/calls-call.xml"/>
</chapter>
<part id="api-reference">
<title>Api Reference</title>
<chapter id="classes">
<title>Widgets and Objects</title>
<xi:include href="xml/calls-account.xml"/>
<xi:include href="xml/calls-account-overview.xml"/>
<xi:include href="xml/calls-account-provider.xml"/>
<xi:include href="xml/calls-account-row.xml"/>
<xi:include href="xml/calls-best-match.xml"/>
<xi:include href="xml/calls-call-record.xml"/>
<xi:include href="xml/calls-call-record-row.xml"/>
<xi:include href="xml/calls-call-selector-item.xml"/>
<xi:include href="xml/calls-call-window.xml"/>
<xi:include href="xml/calls-contacts-box.xml"/>
<xi:include href="xml/calls-contacts-provider.xml"/>
<xi:include href="xml/calls-contacts-row.xml"/>
<xi:include href="xml/calls-dbus-manager.xml"/>
<xi:include href="xml/calls-history-box.xml"/>
<xi:include href="xml/calls-in-app-notification.xml"/>
<xi:include href="xml/calls-main-window.xml"/>
<xi:include href="xml/calls-manager.xml"/>
<xi:include href="xml/calls-network-watch.xml"/>
<xi:include href="xml/calls-new-call-box.xml"/>
<xi:include href="xml/calls-notifier.xml"/>
<xi:include href="xml/calls-record-store.xml"/>
<xi:include href="xml/calls-ringer.xml"/>
<xi:include href="xml/calls-secret-store.xml"/>
<xi:include href="xml/calls-settings.xml"/>
<xi:include href="xml/calls-ui-call-data.xml"/>
<xi:include href="xml/calls-ussd.xml"/>
</chapter>
<chapter id="dbus">
<title>DBus interfaces</title>
<xi:include href="../src/dbus/calls-org.gnome.Calls.Call.xml"/>
</chapter>
<chapter id="utils">
<title>Utilities</title>
<xi:include href="xml/calls-log.xml"/>
<xi:include href="xml/util.xml"/>
</chapter>
<chapter id="provider-abstraction">
<title>Provider abstraction</title>
<xi:include href="xml/calls-message-source.xml"/>
<xi:include href="xml/calls-provider.xml"/>
<xi:include href="xml/calls-origin.xml"/>
<xi:include href="xml/calls-call.xml"/>
</chapter>
<chapter id="dbus">
<title>DBus interfaces</title>
<xi:include href="../src/dbus/calls-org.gnome.Calls.Call.xml"/>
</chapter>
<chapter id="gen_dbus_server">
<title>Generated DBus Servers</title>
<xi:include href="xml/calls-call-dbus.xml"/>
</chapter>
</part>
<part id="annexes">
<title>Annexes</title>
<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>
</part>
</book>