NetworkManager r4310 - trunk/libnm-util

[dcbw svn gnome org]

Author: dcbw
Date: Thu Nov 20 12:33:08 2008
New Revision: 4310
URL: http://svn.gnome.org/viewvc/NetworkManager?rev=4310&view=rev

Log:
more documentation

Modified:
   trunk/libnm-util/nm-setting.c

Modified: trunk/libnm-util/nm-setting.c
==============================================================================
--- trunk/libnm-util/nm-setting.c	(original)
+++ trunk/libnm-util/nm-setting.c	Thu Nov 20 12:33:08 2008
@@ -53,6 +53,16 @@
 	g_slice_free (GValue, value);
 }
 
+/**
+ * nm_setting_to_hash:
+ * @setting: the #NMSetting
+ *
+ * Converts the #NMSetting into a #GHashTable mapping each setting property
+ * name to a GValue describing that property, suitable for marshalling over
+ * D-Bus or serializing.  The mapping is string:GValue.
+ * 
+ * Returns: a new #GHashTable describing the setting's properties
+ **/
 GHashTable *
 nm_setting_to_hash (NMSetting *setting)
 {