Commit 2328650d authored by Dan Williams's avatar Dan Williams
Browse files

Documentation fixes

git-svn-id: http://svn-archive.gnome.org/svn/NetworkManager/trunk@4328 4912f4e0-d625-0410-9fb7-b9a5a253dbdc
parent 4b6a52b1
......@@ -426,7 +426,7 @@ nm_connection_get_setting_by_name (NMConnection *connection, const char *name)
* @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 @@ compare_one_setting (gpointer key, gpointer value, gpointer user_data)
* 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 @@ hash_values_to_slist (gpointer key, gpointer value, gpointer user_data)
* 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 @@ nm_connection_verify (NMConnection *connection, GError **error)
* 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,
......
......@@ -293,7 +293,7 @@ nm_setting_get_name (NMSetting *setting)
* 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 @@ nm_setting_verify (NMSetting *setting, GSList *all_settings, GError **error)
* 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 @@ nm_setting_compare (NMSetting *setting,
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 @@ nm_setting_compare (NMSetting *setting,
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_one_cb (gpointer key, gpointer val, gpointer user_data)
* 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)
......
......@@ -118,8 +118,8 @@ typedef enum {
} 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,
......
......@@ -413,7 +413,7 @@ nm_utils_escape_ssid (const guint8 * ssid, guint32 len)
}
/**
* 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
......
......@@ -181,8 +181,8 @@ void nm_utils_ip4_addresses_to_gvalue (GSList *list, GValue *value);
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);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment