2008-11-19 Dan Williams <dcbw@redhat.com>

	* configure.in
	  Makefile.am
	  docs/libnm-util/Makefile.am
	  docs/libnm-util/libnm-util.types
		- Start to document libnm-util

git-svn-id: http://svn-archive.gnome.org/svn/NetworkManager/trunk@4302 4912f4e0-d625-0410-9fb7-b9a5a253dbdc

diff --git a/ChangeLog b/ChangeLog
index 695d725..5b09df9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-11-19  Dan Williams  <dcbw@redhat.com>
+
+       * configure.in
+         Makefile.am
+         docs/libnm-util/Makefile.am
+         docs/libnm-util/libnm-util.types
+               - Start to document libnm-util
+
 2008-11-19  Dan Williams  <dcbw@redhat.com>
 
        * libnm-util/nm-connection.h

diff --git a/Makefile.am b/Makefile.am
index 89fb2ae..6bbddac 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -41,7 +41,8 @@ SUBDIRS += \
           system-settings \
           tools \
           policy \
-          docs/libnm-glib
+          docs/libnm-glib \
+          docs/libnm-util
 
 EXTRA_DIST =                           \
        CONTRIBUTING                    \

diff --git a/configure.in b/configure.in
index 855011d..0274f17 100644 (file)
--- a/configure.in
+++ b/configure.in
@@ -518,6 +518,7 @@ man/nm-tool.1
 po/Makefile.in
 policy/Makefile
 docs/libnm-glib/Makefile
+docs/libnm-util/Makefile
 NetworkManager.pc
 ])
 AC_OUTPUT

diff --git a/docs/libnm-util/Makefile.am b/docs/libnm-util/Makefile.am
new file mode 100644 (file)
index 0000000..c528e70
--- /dev/null
+++ b/docs/libnm-util/Makefile.am
@@ -0,0 +1,61 @@
+## Process this file with automake to produce Makefile.in
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module
+DOC_MODULE=libnm-util
+
+# 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-util
+
+# 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= \
+       crypto.h \
+       nm-setting-ip6-config.h \
+       nm-setting-template.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   \
+       $(GLIB_CFLAGS)                  \
+       $(DBUS_CFLAGS)
+
+GTKDOC_LIBS = $(top_builddir)/libnm-util/libnm-util.la
+
+
+# include common portion ...
+include $(top_srcdir)/gtk-doc.make
+

diff --git a/docs/libnm-util/libnm-util.types b/docs/libnm-util/libnm-util.types
new file mode 100644 (file)
index 0000000..a0b1ead
--- /dev/null
+++ b/docs/libnm-util/libnm-util.types
@@ -0,0 +1,30 @@
+#include <nm-connection.h>
+#include <nm-setting-8021x.h>
+#include <nm-setting-cdma.h>
+#include <nm-setting-connection.h>
+#include <nm-setting-gsm.h>
+#include <nm-setting.h>
+#include <nm-setting-ip4-config.h>
+#include <nm-setting-ppp.h>
+#include <nm-setting-pppoe.h>
+#include <nm-setting-serial.h>
+#include <nm-setting-vpn.h>
+#include <nm-setting-wired.h>
+#include <nm-setting-wireless.h>
+#include <nm-setting-wireless-security.h>
+
+nm_connection_get_type
+nm_setting_802_1x_get_type
+nm_setting_cdma_get_type
+nm_setting_connection_get_type
+nm_setting_gsm_get_type
+nm_setting_get_type
+nm_setting_ip4_config_get_type
+nm_setting_ppp_get_type
+nm_setting_pppoe_get_type
+nm_setting_serial_get_type
+nm_setting_vpn_get_type
+nm_setting_wired_get_type
+nm_setting_wireless_get_type
+nm_setting_wireless_security_get_type
+