docs: correct NMSettingBond documentation errors

This commit is contained in:
Jiří Klimeš
2012-02-20 12:12:40 +01:00
parent 261d760a8b
commit 7b9c728b85
2 changed files with 11 additions and 11 deletions

View File

@@ -18,7 +18,7 @@
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA. * Boston, MA 02110-1301 USA.
* *
* (C) Copyright 2011 Red Hat, Inc. * (C) Copyright 2011 - 2012 Red Hat, Inc.
*/ */
#include <string.h> #include <string.h>
@@ -139,7 +139,7 @@ nm_setting_bond_get_num_options (NMSettingBond *setting)
* @out_value: (out): on return, the value of the name of the bonding * @out_value: (out): on return, the value of the name of the bonding
* option; this value is owned by the setting and should not be modified * option; this value is owned by the setting and should not be modified
* *
* Given an index, return the value of the bonding option at that index. indexes * Given an index, return the value of the bonding option at that index. Indexes
* are *not* guaranteed to be static across modifications to options done by * are *not* guaranteed to be static across modifications to options done by
* nm_setting_bond_add_option() and nm_setting_bond_remove_option(), * nm_setting_bond_add_option() and nm_setting_bond_remove_option(),
* and should not be used to refer to options except for short periods of time * and should not be used to refer to options except for short periods of time
@@ -247,7 +247,7 @@ gboolean nm_setting_bond_add_option (NMSettingBond *setting,
} }
/** /**
* nm_setting_bond_remove_options: * nm_setting_bond_remove_option:
* @setting: the #NMSettingBond * @setting: the #NMSettingBond
* @name: name of the option to remove * @name: name of the option to remove
* *
@@ -452,7 +452,7 @@ nm_setting_bond_class_init (NMSettingBondClass *setting_class)
/** /**
* NMSettingBond:interface-name: * NMSettingBond:interface-name:
* *
* Name of virtual kernel interface * The name of the virtual in-kernel bonding nework interface
**/ **/
g_object_class_install_property g_object_class_install_property
(object_class, PROP_INTERFACE_NAME, (object_class, PROP_INTERFACE_NAME,
@@ -463,9 +463,9 @@ nm_setting_bond_class_init (NMSettingBondClass *setting_class)
G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE));
/** /**
* NMSettingBridge:options: * NMSettingBond:options:
* *
* Dictionary of key/value pairs of bridging options. Both keys * Dictionary of key/value pairs of bonding options. Both keys
* and values must be strings. Option names must contain only * and values must be strings. Option names must contain only
* alphanumeric characters (ie, [a-zA-Z0-9]). * alphanumeric characters (ie, [a-zA-Z0-9]).
**/ **/

View File

@@ -18,7 +18,7 @@
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA. * Boston, MA 02110-1301 USA.
* *
* (C) Copyright 2011 Red Hat, Inc. * (C) Copyright 2011 - 2012 Red Hat, Inc.
*/ */
#ifndef NM_SETTING_BOND_H #ifndef NM_SETTING_BOND_H
@@ -91,7 +91,7 @@ const char * nm_setting_bond_get_option_by_name (NMSettingBond *setting,
const char *name); const char *name);
gboolean nm_setting_bond_add_option (NMSettingBond *setting, gboolean nm_setting_bond_add_option (NMSettingBond *setting,
const char *name, const char *name,
const char *item); const char *value);
gboolean nm_setting_bond_remove_option (NMSettingBond *setting, gboolean nm_setting_bond_remove_option (NMSettingBond *setting,
const char *name); const char *name);