NetworkManager r4333 - in trunk: docs/libnm-util libnm-util

[dcbw svn gnome org]

Author: dcbw
Date: Mon Nov 24 16:55:37 2008
New Revision: 4333
URL: http://svn.gnome.org/viewvc/NetworkManager?rev=4333&view=rev

Log:
Documentation updates

Modified:
   trunk/docs/libnm-util/Makefile.am
   trunk/libnm-util/nm-utils.c
   trunk/libnm-util/nm-utils.h

Modified: trunk/docs/libnm-util/Makefile.am
==============================================================================
--- trunk/docs/libnm-util/Makefile.am	(original)
+++ trunk/docs/libnm-util/Makefile.am	Mon Nov 24 16:55:37 2008
@@ -32,7 +32,9 @@
 IGNORE_HFILES= \
 	crypto.h \
 	nm-setting-ip6-config.h \
-	nm-setting-template.h
+	nm-setting-template.h \
+	nm-utils-private.h \
+	nm-param-spec-specialized.h
 
 # Images to copy into HTML directory.
 HTML_IMAGES = 

Modified: trunk/libnm-util/nm-utils.c
==============================================================================
--- trunk/libnm-util/nm-utils.c	(original)
+++ trunk/libnm-util/nm-utils.c	Mon Nov 24 16:55:37 2008
@@ -45,6 +45,15 @@
 #include "nm-setting-ip6-config.h"
 #include "crypto.h"
 
+/**
+ * SECTION:nm-utils
+ * @short_description: Utility functions
+ * @include: nm-utils.h
+ *
+ * A collection of utility functions for working SSIDs, IP addresses, WiFi
+ * access points and devices, among other things.
+ */
+
 /* IP6 currently incomplete */
 GSList *nm_utils_ip6_addresses_from_gvalue (const GValue *value);
 void nm_utils_ip6_addresses_to_gvalue (GSList *list, GValue *value);

Modified: trunk/libnm-util/nm-utils.h
==============================================================================
--- trunk/libnm-util/nm-utils.h	(original)
+++ trunk/libnm-util/nm-utils.h	Mon Nov 24 16:55:37 2008
@@ -35,6 +35,11 @@
 /* The API defined here is _NOT_ guaranteed in any way!! */
 /*********************************************************/
 
+/**
+ * nm_print_backtrace:
+ *
+ * Prints a backtrace of the calling process to the logging location.
+ */
 #define nm_print_backtrace()						\
 G_STMT_START								\
 {									\
@@ -59,6 +64,12 @@
 }									\
 G_STMT_END
 
+/**
+ * nm_get_timestamp:
+ * @timestamp: location in which to place the current timestamp
+ *
+ * For debugging only.
+ */
 #define nm_get_timestamp(timestamp)					\
 G_STMT_START								\
 {									\
@@ -153,8 +164,6 @@
 void        nm_utils_slist_free       (GSList *list,
 							    GDestroyNotify elem_destroy_fn);
 
-void        nm_utils_register_value_transformations (void);
-
 typedef enum {
 	NMU_SEC_INVALID = 0,
 	NMU_SEC_NONE,