From: Lubomir Rintel Date: Sat, 26 Mar 2016 09:17:34 +0000 (+0100) Subject: docs: replace spec.html with docbook D-Bus API reference X-Git-Url: https://iam.tj/gitweb/gitweb.cgi?p=NetworkManager.git;a=commitdiff_plain;h=3a2803b42c1547337d25767baa1028b047893589 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. --- diff --git a/.gitignore b/.gitignore index 7a880bba2..89911274c 100644 --- a/.gitignore +++ b/.gitignore @@ -70,7 +70,6 @@ test-*.trs /docs/api/version.xml /docs/api/settings-spec.html /docs/api/settings-spec.xml -/docs/api/spec.html /docs/api/*.stamp /docs/api/html/ /docs/api/tmpl/ 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 @@ ]> - NetworkManager D-Bus Reference Manual + NetworkManager D-Bus API Reference Manual Version &version; 2012 + 2016 The NetworkManager Authors @@ -36,13 +37,52 @@ - + D-Bus API Reference + This part documents the D-Bus interface used to access the NetworkManager daemon. - + +
+ Interfaces + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/examples/python/dbus/create-bond.py b/examples/python/dbus/create-bond.py index 41ffabe8e..f36426ca4 100755 --- a/examples/python/dbus/create-bond.py +++ b/examples/python/dbus/create-bond.py @@ -21,7 +21,7 @@ # This example configures a Bond from ethernet devices and activates it # # NetworkManager D-Bus API: -# https://developer.gnome.org/NetworkManager/1.0/spec.html +# https://developer.gnome.org/NetworkManager/stable/spec.html # import dbus, sys, uuid diff --git a/tools/Makefile.am b/tools/Makefile.am index 27d6bcc41..91ada71a0 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -1,7 +1,6 @@ EXTRA_DIST = \ check-exports.sh \ debug-helper.py \ - doc-generator.xsl \ run-test-valgrind.sh \ run-test-dbus-session.sh \ test-networkmanager-service.py \ diff --git a/tools/doc-generator.xsl b/tools/doc-generator.xsl deleted file mode 100644 index bcc88e837..000000000 --- a/tools/doc-generator.xsl +++ /dev/null @@ -1,691 +0,0 @@ - - - - - - - - - - - - - - - - -

Errors:

- -
- - -

Generic types:

- -
- - - -

Simple types:

- -
- - -

Enumerated types:

- -
- - -

Sets of flags:

- -
- - -

Structure types:

- -
- - -

Mapping types:

- -
- - -

Types defined elsewhere:

-
-
-
- - -

- -
- - -
- -
-
- -
- -
-
- - - - - -

- - -

- This interface is - and is likely to cause havoc to your API/ABI if bindings are generated. - Don't include it in libraries that care about compatibility. -

-
- - -

Implementations of this interface must also implement:

-
    - -
  • -
    -
-
- - - - - -

Methods:

- -
- -

Interface has no methods.

-
-
- - - -

Signals:

- -
- -

Interface has no signals.

-
-
- - - -

Properties:

-
- -
-
- -

Interface has no properties.

-
-
- - - -
- - -

- - - -

- -
- - - - - - - - - - - -
=
- - -
-
- -
(Undocumented)
-
-
-
-
-
- - -

- - - -

- -
- - - - - - - - - - - -
=
- - -
-
- -
(Undocumented)
-
-
-
-
-
- - -
- - - - - - - () - -
-
- -
-
- - -
-

- - - - a{ - - - : - - - - } -

-
- -
-
-

Members

-
- -
-
-
-
- - - - - - - - - -
-

- - - - -

-
- -
-
-
- - -
-
- - - - -
-
Defined by:
-
-
- - - - ( - - , - ) - - - - - a{ - - - } - - - -
-

- - - - ( - - - : - - , - - ) -

-
- -
- - -

In bindings that need a separate name, arrays of - should be called - .

-
- -

Arrays of don't generally - make sense.

-
-
-
-

Members

-
- -
-
-
-
- - -
-

- - - ( - - : - , - - ) → - - - - - , - - - nothing - -

-
- -
- - -
-

Parameters

-
- -
-
-
- - -
-

Returns

-
- -
-
-
- - -
-

Possible errors

-
- -
-
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - ERR: Unable to find type ' - - ' - - - - () - - - - -
- - - - -
-
- - - - - - (undocumented) - - -
-
- - -
- - - - -
-
- -
-
- - -
- - - - - - -
-
- -
-
- - -
- -
-
- - - - - - - (generic description) - - - (Undocumented.) - - -
-
- - -
-

- - - ( - - : - , - - )

-
- -
- - -
-

Parameters

-
- -
-
-
-
-
- - - - - - - - <xsl:value-of select="tp:title"/> - <xsl:if test="tp:version"> - <xsl:text> version </xsl:text> - <xsl:value-of select="tp:version"/> - </xsl:if> - - - - -

- -

- -

Version

-
- - - - -

Interfaces

-
    - -
  • -
    -
- - - - - -

Index

-

Index of interfaces

-
    - -
  • -
    -
-

Index of types

-
    - - -
  • - - - - - - -
  • -
    -
- - -
- -
- -