Preliminary documentation of provider interfaces
* Preliminary documentation of CallsCall and CallsMessageSource * Documentation and cleaning up of CallsCallData * Add data files and meson rules to create gtk-doc documentation * Move some macros from util.h to calls-message-source.h
This commit is contained in:
38
doc/calls-docs.xml
Normal file
38
doc/calls-docs.xml
Normal file
@@ -0,0 +1,38 @@
|
||||
<?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;">Calls</ulink> is a dialer program for telephony calls.
|
||||
</para>
|
||||
<para>
|
||||
If you find any issues in this API reference, please report it
|
||||
using <ulink type="http" url="&package_bugreport;">at the
|
||||
bugtracker</ulink>
|
||||
</para>
|
||||
</releaseinfo>
|
||||
|
||||
<copyright>
|
||||
<year>2018</year>
|
||||
<holder>Purism SPC</holder>
|
||||
</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>
|
||||
|
||||
</book>
|
31
doc/meson.build
Normal file
31
doc/meson.build
Normal file
@@ -0,0 +1,31 @@
|
||||
if get_option('gtk_doc')
|
||||
|
||||
subdir('xml')
|
||||
|
||||
glib_prefix = dependency('glib-2.0').get_pkgconfig_variable('prefix')
|
||||
glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
|
||||
docpath = join_paths(get_option('datadir'), 'gtk-doc', 'html')
|
||||
|
||||
gnome.gtkdoc('calls',
|
||||
main_xml: 'calls-docs.xml',
|
||||
src_dir: [
|
||||
join_paths(meson.source_root(), 'src'),
|
||||
join_paths(meson.build_root(), 'src'),
|
||||
join_paths(meson.build_root(), 'libgdbofono'),
|
||||
],
|
||||
dependencies: calls_deps,
|
||||
scan_args: [
|
||||
'--rebuild-types',
|
||||
],
|
||||
fixxref_args: [
|
||||
'--html-dir=@0@'.format(docpath),
|
||||
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
|
||||
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
|
||||
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gio')),
|
||||
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gi')),
|
||||
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gtk3')),
|
||||
],
|
||||
install_dir: 'calls',
|
||||
install: true)
|
||||
|
||||
endif
|
7
doc/xml/gtkdocentities.ent.in
Normal file
7
doc/xml/gtkdocentities.ent.in
Normal file
@@ -0,0 +1,7 @@
|
||||
<!ENTITY package "@PACKAGE@">
|
||||
<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@">
|
||||
<!ENTITY package_name "@PACKAGE_NAME@">
|
||||
<!ENTITY package_string "@PACKAGE_STRING@">
|
||||
<!ENTITY package_tarname "@PACKAGE_TARNAME@">
|
||||
<!ENTITY package_url "@PACKAGE_URL@">
|
||||
<!ENTITY package_version "@PACKAGE_VERSION@">
|
9
doc/xml/meson.build
Normal file
9
doc/xml/meson.build
Normal file
@@ -0,0 +1,9 @@
|
||||
ent_conf = configuration_data()
|
||||
ent_conf.set('PACKAGE', 'Calls')
|
||||
ent_conf.set('PACKAGE_BUGREPORT', 'https://code.puri.sm/Librem5/calls/issues')
|
||||
ent_conf.set('PACKAGE_NAME', 'Calls')
|
||||
ent_conf.set('PACKAGE_STRING', 'calls')
|
||||
ent_conf.set('PACKAGE_TARNAME', 'calls-' + meson.project_version())
|
||||
ent_conf.set('PACKAGE_URL', 'https://code.puri.sm/Librem5/calls')
|
||||
ent_conf.set('PACKAGE_VERSION', meson.project_version())
|
||||
configure_file(input: 'gtkdocentities.ent.in', output: 'gtkdocentities.ent', configuration: ent_conf)
|
Reference in New Issue
Block a user