summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2016-03-26 10:17:34 +0100
committerLubomir Rintel <lkundrak@v3.sk>2016-03-26 11:28:19 +0100
commit078246a3c4a8d9d55b01d557b25496171b0cca3b (patch)
treed6bf7c2d8362983fbad72360a3cff158fe0ab877 /docs/api
parenta0c42bd4e3cd2349a88efdfd80a450a7cd171748 (diff)
docs: replace spec.html with docbook D-Bus API reference
May use a lot of improvement (actually documenting the names and objects that use the interfaces in question), but at least this looks a lot better on developer.gnome.org.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/Makefile.am51
-rw-r--r--docs/api/network-manager-docs.xml46
2 files changed, 79 insertions, 18 deletions
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am
index 1b50d02b6..d369dd545 100644
--- a/docs/api/Makefile.am
+++ b/docs/api/Makefile.am
@@ -8,10 +8,9 @@ OTHER_FILES= \
$(top_srcdir)/introspection/generic-types.xml \
$(top_srcdir)/introspection/errors.xml \
$(top_srcdir)/introspection/vpn-errors.xml \
- $(top_srcdir)/tools/doc-generator.xsl \
$(top_srcdir)/introspection/generic-types.xml
-GENERATED_FILES = spec.html
+GENERATED_FILES =
if SETTING_DOCS_AVAILABLE
@@ -23,15 +22,6 @@ $(DOC_MAIN_SGML_FILE): settings-spec.xml
GENERATED_FILES += settings-spec.xml
-endif
-
-if ENABLE_GTK_DOC
-
-spec.html: $(XMLS) $(OTHER_FILES) html-build.stamp
- $(XSLTPROC) --path "$(top_builddir)/introspection:$(top_srcdir)/introspection" $(top_srcdir)/tools/doc-generator.xsl $(top_builddir)/introspection/all.xml > spec.html
- mkdir -p $(builddir)/html/
- cp spec.html $(builddir)/html/
-
all: $(GENERATED_FILES)
endif
@@ -62,6 +52,41 @@ content_files = \
../../COPYING \
$(NULL)
+expand_content_files = \
+ $(top_builddir)/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml \
+ $(top_builddir)/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml \
+ $(top_builddir)/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml \
+ $(top_builddir)/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml \
+ $(top_builddir)/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml \
+ $(top_builddir)/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml \
+ $(top_builddir)/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml \
+ $(top_builddir)/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml \
+ $(top_builddir)/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml \
+ $(top_builddir)/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml \
+ $(top_builddir)/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml \
+ $(top_builddir)/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml \
+ $(top_builddir)/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml \
+ $(top_builddir)/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml \
+ $(top_builddir)/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml \
+ $(top_builddir)/introspection/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml \
+ $(top_builddir)/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml \
+ $(top_builddir)/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml \
+ $(top_builddir)/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml \
+ $(top_builddir)/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml \
+ $(top_builddir)/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
+ $(top_builddir)/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml \
+ $(top_builddir)/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml \
+ $(top_builddir)/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml \
+ $(top_builddir)/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml \
+ $(top_builddir)/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml \
+ $(top_builddir)/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml \
+ $(top_builddir)/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml \
+ $(top_builddir)/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml \
+ $(top_builddir)/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml \
+ $(top_builddir)/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml \
+ $(top_builddir)/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml \
+ $(top_builddir)/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml
+
include $(top_srcdir)/gtk-doc.make
####################################
@@ -74,7 +99,3 @@ CLEANFILES += html/* tmpl/* xml/* \
if BUILD_SETTING_DOCS
CLEANFILES += settings-spec.xml
endif
-
-if ENABLE_GTK_DOC
-CLEANFILES += spec.html
-endif
diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml
index e8c99460d..9b491c7ef 100644
--- a/docs/api/network-manager-docs.xml
+++ b/docs/api/network-manager-docs.xml
@@ -5,11 +5,12 @@
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>NetworkManager D-Bus Reference Manual</title>
+ <title>NetworkManager D-Bus API Reference Manual</title>
<releaseinfo>Version &version;</releaseinfo>
<copyright>
<year>2012</year>
+ <year>2016</year>
<holder>The NetworkManager Authors</holder>
</copyright>
@@ -36,13 +37,52 @@
</legalnotice>
</bookinfo>
- <chapter id="ref-dbus">
+ <chapter id="spec">
<title>D-Bus API Reference</title>
+
<para>
This part documents the D-Bus interface used to access the
NetworkManager daemon.
</para>
- <ulink url="spec.html"/>
+
+ <section id="dbus-interfaces">
+ <title>Interfaces</title>
+ <!-- TODO: Split me into chapters about daemon, vpn plugins, dispatcher and the secret agent.
+ Then describe the daemon's singletons and object hierarchy. -->
+ <xi:include href="xml/nmdbus-manager-org.freedesktop.NetworkManager.xml"/>
+ <xi:include href="xml/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml"/>
+ <xi:include href="xml/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml"/>
+ <xi:include href="xml/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml"/>
+ <xi:include href="xml/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml"/>
+ <xi:include href="xml/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml"/>
+ <xi:include href="xml/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml"/>
+ <xi:include href="xml/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml"/>
+ <xi:include href="xml/nmdbus-device-org.freedesktop.NetworkManager.Device.xml"/>
+ <xi:include href="xml/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml"/>
+ <xi:include href="xml/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml"/>
+ <xi:include href="xml/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml"/>
+ <xi:include href="xml/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml"/>
+ <xi:include href="xml/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml"/>
+ <xi:include href="xml/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml"/>
+ <xi:include href="xml/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml"/>
+ <xi:include href="xml/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml"/>
+ <xi:include href="xml/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml"/>
+ <xi:include href="xml/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml"/>
+ <xi:include href="xml/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml"/>
+ <xi:include href="xml/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml"/>
+ <xi:include href="xml/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml"/>
+ <xi:include href="xml/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml"/>
+ <xi:include href="xml/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml"/>
+ <xi:include href="xml/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml"/>
+ <xi:include href="xml/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml"/>
+ <xi:include href="xml/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml"/>
+ <xi:include href="xml/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml"/>
+ <xi:include href="xml/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml"/>
+ <xi:include href="xml/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml"/>
+ <xi:include href="xml/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml"/>
+ <xi:include href="xml/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml"/>
+ <xi:include href="xml/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml"/>
+ </section>
</chapter>
<chapter id="ref-settings">