NetworkManager r4328 - trunk/libnm-util

[dcbw svn gnome org]

Author: dcbw
Date: Sun Nov 23 22:55:03 2008
New Revision: 4328
URL: http://svn.gnome.org/viewvc/NetworkManager?rev=4328&view=rev

Log:
Documentation fixes

Modified:
   trunk/libnm-util/nm-connection.c
   trunk/libnm-util/nm-setting.c
   trunk/libnm-util/nm-setting.h
   trunk/libnm-util/nm-utils.c
   trunk/libnm-util/nm-utils.h

Modified: trunk/libnm-util/nm-connection.c
==============================================================================
--- trunk/libnm-util/nm-connection.c	(original)
+++ trunk/libnm-util/nm-connection.c	Sun Nov 23 22:55:03 2008
@@ -426,7 +426,7 @@
  * @new_settings: a #GHashTable of settings
  * @error: location to store error, or %NULL
  *
- * Returns: TRUE if the settings were valid and added to the connection, FALSE
+ * Returns: %TRUE if the settings were valid and added to the connection, %FALSE
  * if they were not
  **/
 gboolean
@@ -479,7 +479,7 @@
  * modified by a set of flags.  See nm_setting_compare() for a description of
  * each flag's behavior.
  *
- * Returns: TRUE if the comparison succeeds, FALSE if it does not
+ * Returns: %TRUE if the comparison succeeds, %FALSE if it does not
  **/
 gboolean
 nm_connection_compare (NMConnection *a,
@@ -549,7 +549,7 @@
  * MAC address.  The returned #GError contains information about which
  * setting and which property failed validation, and how it failed validation.
  *
- * Returns: TRUE if the connection is valid, FALSE if it is not
+ * Returns: %TRUE if the connection is valid, %FALSE if it is not
  **/
 gboolean
 nm_connection_verify (NMConnection *connection, GError **error)
@@ -603,8 +603,8 @@
  * Update the specified setting's secrets, given a hash table of secrets
  * intended for that setting (deserialized from D-Bus for example).
  * 
- * Returns: TRUE if the secrets were successfully updated and the connection
- * is valid, FALSE on failure or if the setting was never added to the connection
+ * Returns: %TRUE if the secrets were successfully updated and the connection
+ * is valid, %FALSE on failure or if the setting was never added to the connection
  **/
 gboolean
 nm_connection_update_secrets (NMConnection *connection,

Modified: trunk/libnm-util/nm-setting.c
==============================================================================
--- trunk/libnm-util/nm-setting.c	(original)
+++ trunk/libnm-util/nm-setting.c	Sun Nov 23 22:55:03 2008
@@ -293,7 +293,7 @@
  * returned #GError contains information about which property of the setting
  * failed validation, and in what way that property failed validation.
  *
- * Returns: TRUE if the setting is valid, FALSE if it is not
+ * Returns: %TRUE if the setting is valid, %FALSE if it is not
  **/
 gboolean
 nm_setting_verify (NMSetting *setting, GSList *all_settings, GError **error)
@@ -318,11 +318,11 @@
  * modified by a set of flags.  See the documentation for #NMSettingCompareFlags
  * for a description of each flag's behavior.
  *
- * Returns: TRUE if the comparison succeeds, FALSE if it does not
+ * Returns: %TRUE if the comparison succeeds, %FALSE if it does not
  **/
 gboolean
-nm_setting_compare (NMSetting *setting,
-                    NMSetting *other,
+nm_setting_compare (NMSetting *a,
+                    NMSetting *b,
                     NMSettingCompareFlags flags)
 {
 	GParamSpec **property_specs;
@@ -330,15 +330,15 @@
 	gint different;
 	guint i;
 
-	g_return_val_if_fail (NM_IS_SETTING (setting), FALSE);
-	g_return_val_if_fail (NM_IS_SETTING (other), FALSE);
+	g_return_val_if_fail (NM_IS_SETTING (a), FALSE);
+	g_return_val_if_fail (NM_IS_SETTING (b), FALSE);
 
 	/* First check that both have the same type */
-	if (G_OBJECT_TYPE (setting) != G_OBJECT_TYPE (other))
+	if (G_OBJECT_TYPE (a) != G_OBJECT_TYPE (b))
 		return FALSE;
 
 	/* And now all properties */
-	property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (setting), &n_property_specs);
+	property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (a), &n_property_specs);
 	different = FALSE;
 
 	for (i = 0; i < n_property_specs && !different; i++) {
@@ -357,15 +357,15 @@
 			continue;
 
 		if (   (flags & NM_SETTING_COMPARE_FLAG_IGNORE_ID)
-			   && !strcmp (nm_setting_get_name (setting), NM_SETTING_CONNECTION_SETTING_NAME)
+			   && !strcmp (nm_setting_get_name (a), NM_SETTING_CONNECTION_SETTING_NAME)
 		    && !strcmp (prop_spec->name, NM_SETTING_CONNECTION_ID))
 			continue;
 
 		g_value_init (&value1, prop_spec->value_type);
-		g_object_get_property (G_OBJECT (setting), prop_spec->name, &value1);
+		g_object_get_property (G_OBJECT (a), prop_spec->name, &value1);
 
 		g_value_init (&value2, prop_spec->value_type);
-		g_object_get_property (G_OBJECT (other), prop_spec->name, &value2);
+		g_object_get_property (G_OBJECT (b), prop_spec->name, &value2);
 
 		different = g_param_values_cmp (prop_spec, &value1, &value2);
 
@@ -540,8 +540,8 @@
  * Update the setting's secrets, given a hash table of secrets intended for that
  * setting (deserialized from D-Bus for example).
  * 
- * Returns: TRUE if the secrets were successfully updated and the connection
- * is valid, FALSE on failure or if the setting was never added to the connection
+ * Returns: %TRUE if the secrets were successfully updated and the connection
+ * is valid, %FALSE on failure or if the setting was never added to the connection
  **/
 gboolean
 nm_setting_update_secrets (NMSetting *setting, GHashTable *secrets, GError **error)

Modified: trunk/libnm-util/nm-setting.h
==============================================================================
--- trunk/libnm-util/nm-setting.h	(original)
+++ trunk/libnm-util/nm-setting.h	Sun Nov 23 22:55:03 2008
@@ -118,8 +118,8 @@
 } NMSettingCompareFlags;
 
 /* Returns TRUE if the connections are the same */
-gboolean    nm_setting_compare       (NMSetting *setting,
-                                      NMSetting *other,
+gboolean    nm_setting_compare       (NMSetting *a,
+                                      NMSetting *b,
                                       NMSettingCompareFlags flags);
 
 void        nm_setting_enumerate_values (NMSetting *setting,

Modified: trunk/libnm-util/nm-utils.c
==============================================================================
--- trunk/libnm-util/nm-utils.c	(original)
+++ trunk/libnm-util/nm-utils.c	Sun Nov 23 22:55:03 2008
@@ -413,7 +413,7 @@
 }
 
 /**
- * nm_utils_escape_ssid:
+ * nm_utils_same_ssid:
  * @ssid1: first SSID data to compare
  * @ssid2: second SSID data to compare
  * @ignore_trailing_null: TRUE to ignore one trailing NULL byte

Modified: trunk/libnm-util/nm-utils.h
==============================================================================
--- trunk/libnm-util/nm-utils.h	(original)
+++ trunk/libnm-util/nm-utils.h	Sun Nov 23 22:55:03 2008
@@ -181,8 +181,8 @@
 GSList *nm_utils_ip4_routes_from_gvalue (const GValue *value);
 void nm_utils_ip4_routes_to_gvalue (GSList *list, GValue *value);
 
-guint32 nm_utils_ip4_netmask_to_prefix (guint32 ip4_netmask);
-guint32 nm_utils_ip4_prefix_to_netmask (guint32 ip4_prefix);
+guint32 nm_utils_ip4_netmask_to_prefix (guint32 netmask);
+guint32 nm_utils_ip4_prefix_to_netmask (guint32 prefix);
 
 char *nm_utils_uuid_generate (void);
 char *nm_utils_uuid_generate_from_string (const char *s);