Commit c03d86a4 authored by Jussi Kukkonen's avatar Jussi Kukkonen

first version of dbus docs, C lib docs

parent cce8e51d
......@@ -26,6 +26,7 @@ missing
*.service
*.pc
*-glue.h
*-bindings.h
doxygen.conf
......
......@@ -16,6 +16,7 @@ AC_PROG_GCC_TRADITIONAL
AM_PROG_LIBTOOL
GTK_DOC_CHECK(1.0)
AC_CHECK_PROGS(XSLT, xsltproc)
AC_ARG_ENABLE(system-bus,
[AC_HELP_STRING([--enable-system-bus],
......@@ -61,6 +62,7 @@ AC_CONFIG_FILES([
Makefile
docs/Makefile
docs/reference/Makefile
docs/tools/Makefile
interfaces/Makefile
geoclue/Makefile
example/Makefile
......
SUBDIRS = reference
SUBDIRS = reference tools
......@@ -48,17 +48,38 @@ CFILE_GLOB=$(top_srcdir)/geoclue/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES= \
*-marshal.[ch] \
*-glue.c
geoclue-marshal.h \
gc-iface-address-bindings.h \
gc-iface-reverse-geocode-bindings.h \
gc-iface-geoclue-bindings.h \
gc-iface-velocity-bindings.h \
gc-iface-geocode-bindings.h \
gc-iface-position-bindings.h \
gc-iface-address-glue.h \
gc-iface-reverse-geocode-glue.h \
gc-iface-geoclue-glue.h \
gc-iface-velocity-glue.h \
gc-iface-geocode-glue.h \
gc-iface-position-glue.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES=
dbus_docs = \
gc-iface-geoclue-ref.xml \
gc-iface-position-ref.xml \
gc-iface-address-ref.xml \
gc-iface-geocode-ref.xml \
gc-iface-reverse-geocode-ref.xml \
gc-iface-velocity-ref.xml
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files= \
implementing-providers.xml
implementing-providers.xml \
$(dbus_docs)
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
......@@ -79,3 +100,9 @@ include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST +=
CLEAN_FILES = $(dbus_docs)
%-ref.xml: $(top_srcdir)/interfaces/%-full.xml
$(XSLT) -o $@ $(top_srcdir)/docs/tools/spec-to-docbook.xsl $<
......@@ -9,10 +9,7 @@
<reference>
<title>Geoclue for clients</title>
<chapter>
<title>Using Geoclue</title>
</chapter>
<chapter>
<title>Geoclue API</title>
<title>Geoclue C API</title>
<xi:include href="xml/geoclue-common.xml"/>
<xi:include href="xml/geoclue-position.xml"/>
<xi:include href="xml/geoclue-address.xml"/>
......@@ -28,7 +25,7 @@
<title>Geoclue for providers</title>
<xi:include href="implementing-providers.xml"/>
<chapter>
<title>Geoclue provider API</title>
<title>Geoclue provider C API</title>
<xi:include href="xml/gc-provider.xml"/>
<xi:include href="xml/gc-web-service.xml"/>
<xi:include href="xml/gc-iface-geocode.xml"/>
......@@ -39,4 +36,15 @@
<xi:include href="xml/gc-iface-reverse-geocode.xml"/>
</chapter>
</reference>
<reference>
<title>D-Bus API</title>
<xi:include href="gc-iface-geoclue-ref.xml"/>
<xi:include href="gc-iface-position-ref.xml"/>
<xi:include href="gc-iface-address-ref.xml"/>
<xi:include href="gc-iface-geocode-ref.xml"/>
<xi:include href="gc-iface-reverse-geocode-ref.xml"/>
<xi:include href="gc-iface-velocity-ref.xml"/>
</reference>
</book>
This diff is collapsed.
EXTRA_DIST = spec-strip-docs.xsl spec-to-docbook.xsl
<?xml version='1.0'?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
exclude-result-prefixes="doc">
<xsl:output method="xml"
indent="yes"
encoding="UTF-8"
omit-xml-declaration="no"
doctype-system="http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"
doctype-public="-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" />
<xsl:template match="*">
<xsl:copy>
<xsl:for-each select="@*">
<xsl:if test="not(starts-with(name(.), 'doc:'))">
<xsl:copy/>
</xsl:if>
</xsl:for-each>
<xsl:apply-templates/>
</xsl:copy>
</xsl:template>
<xsl:template match="node">
<node>
<xsl:for-each select="@*">
<xsl:if test="not(starts-with(name(.), 'xmlns'))">
<xsl:copy/>
</xsl:if>
</xsl:for-each>
<xsl:apply-templates/>
</node>
</xsl:template>
<xsl:template match="doc:*"/>
<xsl:template match="text()"/>
</xsl:stylesheet>
This diff is collapsed.
noinst_PROGRAMS = \
position-example \
position-signal-example \
address-example \
geocode-example \
revgeocode-example \
......@@ -7,6 +8,7 @@ noinst_PROGRAMS = \
common_example_SOURCES = common-example.c
position_example_SOURCES = position-example.c
position_signal_example_SOURCES = position-signal-example.c
address_example_SOURCES = address-example.c
geocode_example_SOURCES = geocode-example.c
revgeocode_example_SOURCES = revgeocode-example.c
......
EXTRA_DIST = gc-iface-geoclue.xml
%.xml: %-full.xml
$(XSLT) -o $@ $(top_srcdir)/docs/tools/spec-strip-docs.xsl $<
noinst_DATA = \
gc-iface-geoclue.xml \
gc-iface-position.xml \
gc-iface-address.xml \
gc-iface-geocode.xml \
gc-iface-reverse-geocode.xml \
gc-iface-velocity.xml
BUILT_SOURCES = $(noinst_DATA)
CLEANFILES = $(BUILT_SOURCES)
EXTRA_DIST = \
gc-iface-geoclue-full.xml \
gc-iface-position-full.xml \
gc-iface-address-full.xml \
gc-iface-geocode-full.xml \
gc-iface-reverse-geocode-full.xml \
gc-iface-velocity-full.xml
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.Geoclue">
<doc:doc>
<doc:para>Geoclue interface contains methods
and signals common to all providers (and all providers
must implement at least this interface).</doc:para>
</doc:doc>
<method name="GetProviderInfo">
<arg type="s" name="Name" direction="out">
<doc:doc>
<doc:summary>The provider name</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="Description" direction="out">
<doc:doc>
<doc:summary>Short description of the provider</doc:summary>
</doc:doc>
</arg>
</method>
<method name="GetStatus">
<arg type="b" name="active" direction="out" >
<doc:doc>
<doc:summary>Current provider status</doc:summary>
</doc:doc>
</arg>
</method>
<signal name="StatusChanged">
<arg type="b" name="active" direction="out">
<doc:doc>
<doc:summary>Current provider status</doc:summary>
</doc:doc>
</arg>
</signal>
<method name="Shutdown">
<doc:doc>
<doc:description>Shut down the provider</doc:description>
</doc:doc>
</method>
</interface>
</node>
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/">
<interface name="org.freedesktop.Geoclue">
<method name="GetProviderInfo">
<arg type="s" name="Name" direction="out" />
<arg type="s" name="Description" direction="out" />
</method>
<method name="GetStatus">
<arg type="b" name="active" direction="out" />
</method>
<signal name="StatusChanged">
<arg type="b" name="active" direction="out" />
</signal>
<method name="Shutdown" />
</interface>
</node>
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/">
<interface name="org.freedesktop.Geoclue.Position">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.Geoclue.Position">
<doc:doc>
<doc:para>Position interface contains a method
and a signal for querying current coordinates.</doc:para>
</doc:doc>
<method name="GetPosition">
<arg type="i" name="fields" direction="out" />
<arg type="i" name="timestamp" direction="out" />
......
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