Commit 95edb679 authored by Zeeshan Ali's avatar Zeeshan Ali

Generate docs for D-Bus interface

parent 39f341c7
ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
NULL =
SUBDIRS = src data demo po
SUBDIRS = src data demo po docs
INTLTOOL_FILES = \
intltool-extract.in \
......
......@@ -2,11 +2,15 @@
set -e # exit on errors
REQUIRED_AUTOMAKE_VERSION=1.9
srcdir=`dirname $0`
test -z "$srcdir" && srcdir=.
mkdir -p m4
PKG_NAME=GeoClue
git submodule update --init --recursive
gtkdocize
autoreconf -v --force --install
intltoolize -f
......
......@@ -45,6 +45,11 @@ GEOIP_MIN_VERSION=1.5.1
AC_CHECK_LIB([m],[sin])
dnl
dnl Documentation
dnl
GTK_DOC_CHECK(1.0)
PKG_CHECK_MODULES(GEOCLUE, [
glib-2.0 >= $GLIB_MIN_VERSION
gio-2.0 >= $GLIB_MIN_VERSION
......@@ -131,6 +136,8 @@ AC_CONFIG_FILES([
data/org.freedesktop.GeoClue2.conf
data/Makefile
demo/Makefile
docs/Makefile
docs/version.xml
])
AC_OUTPUT
......
NULL =
AUTOMAKE_OPTIONS = 1.7
# The name of the module.
DOC_MODULE=geoclue
# The top-level SGML file.
DOC_MAIN_SGML_FILE=geoclue-docs.xml
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS=--ignore-headers=config.h
# The directory containing the source code. Relative to $(srcdir)
#DOC_SOURCE_DIR=../src
# Used for dependencies
HFILE_GLOB=
#$(top_srcdir)/policy/*.h
CFILE_GLOB=
#$(top_srcdir)/policy/*.c
# Headers to ignore
IGNORE_HFILES= \
$(NULL)
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl
MKTMPL_OPTIONS=
docs-org.freedesktop.GeoClue2.Manager.xml:
cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Manager.xml .
docs-org.freedesktop.GeoClue2.Client.xml:
cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Client.xml .
docs-org.freedesktop.GeoClue2.Location.xml:
cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Location.xml .
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
version.xml \
docs-org.freedesktop.GeoClue2.Manager.xml \
docs-org.freedesktop.GeoClue2.Client.xml \
docs-org.freedesktop.GeoClue2.Location.xml \
$(NULL)
MAINTAINERCLEANFILES = \
*~ \
Makefile.in \
geoclue.types \
geoclue-*.txt \
$(NULL)
if ENABLE_GTK_DOC
include $(top_srcdir)/gtk-doc.make
else
CLEANFILES = $(NULL)
EXTRA_DIST = geoclue-docs.xml
endif
CLEANFILES += \
docs-org.freedesktop.GeoClue2.Manager.xml \
docs-org.freedesktop.GeoClue2.Client.xml \
docs-org.freedesktop.GeoClue2.Location.xml \
$(NULL)
# Version information for marking the documentation
EXTRA_DIST += version.xml.in
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Geoclue Reference Manual</title>
<releaseinfo>Version &version;</releaseinfo>
<authorgroup>
<author>
<firstname>Zeeshan</firstname>
<surname>Ali (Khattak)</surname>
<affiliation>
<address>
<email>zeeshanak@gnome.org</email>
</address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2013</year>
<holder>Red Hat, Inc.</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the <citetitle>GNU Free
Documentation License</citetitle>, Version 1.1 or any later
version published by the Free Software Foundation with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing
to:
<address>
The Free Software Foundation, Inc.,
<street>59 Temple Place</street> - Suite 330,
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
<country>USA</country>
</address>
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and those trademarks
are made aware to the members of the GNOME Documentation
Project, the names have been printed in caps or initial caps.
</para>
</legalnotice>
</bookinfo>
<reference id="ref-dbus">
<title>D-Bus API Reference</title>
<partintro>
<para>
This part documents the D-Bus interface used to access the
Geoclue service.
</para>
</partintro>
<xi:include href="docs-org.freedesktop.GeoClue2.Manager.xml"/>
<xi:include href="docs-org.freedesktop.GeoClue2.Client.xml"/>
<xi:include href="docs-org.freedesktop.GeoClue2.Location.xml"/>
</reference>
<index>
<title>Index</title>
</index>
<!-- License -->
<appendix id="license">
<title>License</title>
<para>
<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
</para>
</appendix>
</book>
......@@ -18,6 +18,7 @@ geoclue-interface.h: Makefile.am $(interface_DATA)
--interface-prefix org.freedesktop.GeoClue2. \
--c-namespace GClue \
--generate-c-code geoclue-interface \
--generate-docbook=docs \
$(srcdir)/$(interface_DATA)
BUILT_SOURCES = \
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment