From 07cccfebb782129d1ebf2459f6965271187f1dcf Mon Sep 17 00:00:00 2001
From: Dan Williams <dcbw@redhat.com>
Date: Thu, 20 Nov 2008 15:49:46 +0000
Subject: [PATCH] Documentation updates

git-svn-id: http://svn-archive.gnome.org/svn/NetworkManager/trunk@4315 4912f4e0-d625-0410-9fb7-b9a5a253dbdc
---
 libnm-util/nm-setting.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/libnm-util/nm-setting.c b/libnm-util/nm-setting.c
index 1241e5d033..fd00f1a2fa 100644
--- a/libnm-util/nm-setting.c
+++ b/libnm-util/nm-setting.c
@@ -566,6 +566,18 @@ nm_setting_update_secrets (NMSetting *setting, GHashTable *secrets, GError **err
 	return *(info->error) ? FALSE : TRUE;
 }
 
+/**
+ * nm_setting_to_string:
+ * @setting: the #NMSetting
+ *
+ * Convert the setting into a string.  For debugging purposes ONLY, should NOT
+ * be used for serialization of the setting, or machine-parsed in any way. The
+ * output format is not guaranteed to be stable and may change at any time.
+ *
+ * Returns: an allocated string containing a textual representation of the
+ * setting's properties and values (including secrets!), which the caller should
+ * free with g_free()
+ **/
 char *
 nm_setting_to_string (NMSetting *setting)
 {
@@ -710,6 +722,14 @@ nm_setting_class_init (NMSettingClass *setting_class)
 	setting_class->update_one_secret = update_one_secret;
 
 	/* Properties */
+
+	/**
+	 * NMSetting:name:
+	 *
+	 * The setting's name, which uniquely identifies the setting within the
+	 * connection.  Each setting type has a name unique to that type, for
+	 * example 'ppp' or 'wireless' or 'wired'.
+	 **/
 	g_object_class_install_property
 		(object_class, PROP_NAME,
 		 g_param_spec_string (NM_SETTING_NAME,
@@ -718,3 +738,4 @@ nm_setting_class_init (NMSettingClass *setting_class)
 						  NULL,
 						  G_PARAM_READWRITE));
 }
+