diff options
| author | Dan Winship <danw@gnome.org> | 2014-11-07 12:38:17 -0500 |
|---|---|---|
| committer | Dan Winship <danw@gnome.org> | 2014-11-07 13:16:54 -0500 |
| commit | cbabd135818fd4749ad0b827ba1f0bc444b92a97 (patch) | |
| tree | 24433faa3c0077c5865525b7878833c9a2f3891b /docs | |
| parent | 941897cc9721997d106e2ab7ac438dafe441fb4e (diff) | |
| download | NetworkManager-cbabd135818fd4749ad0b827ba1f0bc444b92a97.tar.gz | |
libnm, docs: docs fixes
Update the docs build to include and exclude the correct files.
Fill in some missing documentation, and fix problems in the existing
docs. (In particular, "<" can't appear as a literal in documentation,
so change it to "<". Also, "PKCS#12" has to be written as
"PKCS#<!-- -->12", or gtk-doc will think "#12" is a reference to a
type named "12".)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/libnm/Makefile.am | 11 | ||||
| -rw-r--r-- | docs/libnm/libnm-docs.xml | 10 |
2 files changed, 17 insertions, 4 deletions
diff --git a/docs/libnm/Makefile.am b/docs/libnm/Makefile.am index 2d1200b485..e04d1722bf 100644 --- a/docs/libnm/Makefile.am +++ b/docs/libnm/Makefile.am @@ -30,9 +30,11 @@ CFILE_GLOB=$(top_srcdir)/libnm-core/*.c $(top_srcdir)/libnm/*.c # Header files to ignore when scanning. IGNORE_HFILES= \ + common.h \ crypto.h \ - nm-dbus-helpers-private.h \ + nm-dbus-helpers.h \ nm-core-internal.h \ + nm-core-types.h \ nm-device-private.h \ nm-dhcp4-config.h \ nm-dhcp6-config.h \ @@ -41,12 +43,13 @@ IGNORE_HFILES= \ nm-manager.h \ nm-object-cache.h \ nm-object-private.h \ - nm-param-spec-dbus.h \ + nm-property-compare.h \ nm-remote-connection-private.h \ nm-remote-settings.h \ nm-setting-private.h \ - nm-types-private.h \ - nm-utils-private.h + nm-types.h \ + nm-utils-private.h \ + nm-vpn-plugin-old.h # Images to copy into HTML directory. HTML_IMAGES = libnm.png diff --git a/docs/libnm/libnm-docs.xml b/docs/libnm/libnm-docs.xml index e722a30964..2bb9f37521 100644 --- a/docs/libnm/libnm-docs.xml +++ b/docs/libnm/libnm-docs.xml @@ -68,11 +68,14 @@ <xi:include href="xml/nm-client.xml"/> <xi:include href="xml/nm-secret-agent.xml"/> <xi:include href="xml/nm-object.xml"/> + <xi:include href="xml/nm-errors.xml"/> + <xi:include href="xml/nm-dbus-interface.xml"/> </chapter> <chapter> <title>Connection and Setting API Reference</title> <xi:include href="xml/nm-connection.xml"/> + <xi:include href="xml/nm-simple-connection.xml"/> <xi:include href="xml/nm-setting.xml"/> <xi:include href="xml/nm-setting-connection.xml"/> <!-- begin alphabetical --> @@ -135,6 +138,13 @@ <chapter> <title>Utility API Reference</title> <xi:include href="xml/nm-utils.xml"/> + <xi:include href="xml/nm-version.xml"/> + </chapter> + + <chapter> + <title>VPN Plugin API Reference</title> + <xi:include href="xml/nm-vpn-dbus-interface.xml"/> + <xi:include href="xml/nm-vpn-editor-plugin.xml"/> </chapter> <chapter id="object-tree"> |