diff options
| -rw-r--r-- | doc/Makefile.am | 11 | ||||
| -rw-r--r-- | doc/connman-docs.xml | 13 | ||||
| -rw-r--r-- | doc/dbus-manager.xml | 30 |
3 files changed, 52 insertions, 2 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index ecd6b5e9..0d0381f4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -33,10 +33,19 @@ MAINTAINERCLEANFILES = Makefile.in \ if ENABLE_GTK_DOC include $(top_srcdir)/doc/gtk-doc.make + +all-local: xml/dbus-manager.xml + +xml/dbus-manager.xml : dbus-manager.xml dbus-introspection.xsl + echo "<?xml version=\"1.0\"?>" > $@ + echo "<!DOCTYPE refentry PUBLIC \"-//OASIS//DTD DocBook XML V4.1.2//EN\" \"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd\">" >> $@ + $(XSLTPROC) dbus-introspection.xsl $< | tail -n +2 >> $@ + else EXTRA_DIST = $(DOC_MAIN_SGML_FILE) $(content_files) endif -EXTRA_DIST += dbus-introspection.dtd dbus-introspection.xsl +EXTRA_DIST += dbus-introspection.dtd dbus-introspection.xsl \ + dbus-manager.xml EXTRA_DIST += manager-api.txt element-api.txt agent-api.txt plugin-api.txt diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml index 837d8b05..66d895cf 100644 --- a/doc/connman-docs.xml +++ b/doc/connman-docs.xml @@ -57,6 +57,17 @@ <xi:include href="connman-introduction.xml" /> </reference> + <reference id="dbus"> + <title>D-Bus API Reference</title> + <partintro> + <para> + This part presents the D-Bus interface used to access Connection + Manager. + </para> + </partintro> + <xi:include href="xml/dbus-manager.xml"/> + </reference> + <reference id="manager"> <title>Manager interface</title> <para> @@ -72,7 +83,7 @@ </reference> <reference id="reference"> - <title>API Reference</title> + <title>Plugin API Reference</title> <partintro> <para> This part presents the function reference for Connection Manager. diff --git a/doc/dbus-manager.xml b/doc/dbus-manager.xml new file mode 100644 index 00000000..446cd7e9 --- /dev/null +++ b/doc/dbus-manager.xml @@ -0,0 +1,30 @@ +<!DOCTYPE node PUBLIC + "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" + "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> +<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> + + <interface name="org.moblin.connman.Manager"> + + <method name="ListElements"> + <arg name="list" direction="out" type="ao"> + <doc:doc> + <doc:summary> + <doc:para> + List of object paths representing an element. + </doc:para> + </doc:summary> + </doc:doc> + </arg> + + <doc:doc> + <doc:description> + <doc:para> + List all registered elements in the system. + </doc:para> + </doc:description> + </doc:doc> + </method> + + </interface> + +</node> |