diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/libnm-glib/Makefile.am | 79 | ||||
| -rw-r--r-- | docs/libnm-glib/libnm-glib-docs.sgml | 38 | ||||
| -rw-r--r-- | docs/libnm-glib/libnm-glib.types | 23 |
3 files changed, 140 insertions, 0 deletions
diff --git a/docs/libnm-glib/Makefile.am b/docs/libnm-glib/Makefile.am new file mode 100644 index 0000000000..652bd447d9 --- /dev/null +++ b/docs/libnm-glib/Makefile.am @@ -0,0 +1,79 @@ +## Process this file with automake to produce Makefile.in +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module +DOC_MODULE=libnm-glib + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. +DOC_SOURCE_DIR=../../libnm-glib + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-scangobj. +SCANGOBJ_OPTIONS=--type-init-func 'g_type_init();' + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB= +CFILE_GLOB= + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + nm-dbus-utils.h \ + nm-device-private.h \ + nm-object-cache.h \ + nm-object-private.h \ + nm-types-private.h \ + nm-access-point-bindings.h \ + nm-client-bindings.h \ + nm-device-bindings.h \ + nm-device-ethernet-bindings.h \ + nm-device-wifi-bindings.h \ + nm-exported-connection-glue.h \ + nm-exported-connection-bindings.h \ + nm-settings-glue.h \ + nm-settings-bindings.h \ + nm-settings-system-bindings.h \ + nm-vpn-connection-bindings.h \ + nm-vpn-plugin-glue.h \ + nm-active-connection-bindings.h \ + nm-ip4-config-bindings.h \ + nm-dhcp4-config-bindings.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra XML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +GTKDOC_CFLAGS = \ + -I$(top_srcdir)/include \ + -I$(top_srcdir)/libnm-util \ + -I$(top_builddir)/marshallers \ + -I$(top_srcdir)/libnm-glib \ + $(GLIB_CFLAGS) \ + $(DBUS_CFLAGS) + +GTKDOC_LIBS = $(top_builddir)/libnm-glib/libnm_glib.la + + +# include common portion ... +include $(top_srcdir)/gtk-doc.make + diff --git a/docs/libnm-glib/libnm-glib-docs.sgml b/docs/libnm-glib/libnm-glib-docs.sgml new file mode 100644 index 0000000000..5a3ca81b86 --- /dev/null +++ b/docs/libnm-glib/libnm-glib-docs.sgml @@ -0,0 +1,38 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>libnm-glib Reference Manual</title> + <releaseinfo> + for libnm-glib [VERSION] + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/libnm-glib/index.html">http://[SERVER]/libnm-glib/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>[Insert title here]</title> + <xi:include href="xml/nm-access-point.xml"/> + <xi:include href="xml/nm-cdma-device.xml"/> + <xi:include href="xml/nm-client.xml"/> + <xi:include href="xml/nm-gsm-device.xml"/> + <xi:include href="xml/nm-device.xml"/> + <xi:include href="xml/nm-ip4-config.xml"/> + <xi:include href="xml/nm-object.xml"/> + <xi:include href="xml/nm-settings.xml"/> + <xi:include href="xml/nm-vpn-connection.xml"/> + <xi:include href="xml/nm-vpn-plugin.xml"/> + <xi:include href="xml/nm-dbus-settings-system.xml"/> + <xi:include href="xml/nm-active-connection.xml"/> + <xi:include href="xml/nm-device-ethernet.xml"/> + <xi:include href="xml/nm-device-wifi.xml"/> + <xi:include href="xml/nm-dbus-connection.xml"/> + <xi:include href="xml/nm-serial-device.xml"/> + <xi:include href="xml/nm-dbus-settings.xml"/> + <xi:include href="xml/nm-dhcp4-config.xml"/> + <xi:include href="xml/nm-vpn-plugin-ui-interface.xml"/> + <xi:include href="xml/libnm_glib.xml"/> + <xi:include href="xml/nm-types.xml"/> + </chapter> +</book> diff --git a/docs/libnm-glib/libnm-glib.types b/docs/libnm-glib/libnm-glib.types new file mode 100644 index 0000000000..8c5fcf754e --- /dev/null +++ b/docs/libnm-glib/libnm-glib.types @@ -0,0 +1,23 @@ +#include <nm-client.h> +#include <nm-device-ethernet.h> +#include <nm-device-wifi.h> +#include <nm-cdma-device.h> +#include <nm-gsm-device.h> +#include <nm-serial-device.h> +#include <nm-access-point.h> +#include <nm-ip4-config.h> +#include <nm-active-connection.h> +#include <nm-dhcp4-config.h> + +nm_object_get_type +nm_client_get_type +nm_device_get_type +nm_device_ethernet_get_type +nm_device_wifi_get_type +nm_gsm_device_get_type +nm_cdma_device_get_type +nm_serial_device_get_type +nm_access_point_get_type +nm_ip4_config_get_type +nm_active_connection_get_type +nm_dhcp4_config_get_type |