diff options
| author | Dan Winship <danw@gnome.org> | 2014-06-05 15:11:04 -0400 |
|---|---|---|
| committer | Dan Winship <danw@gnome.org> | 2014-06-19 17:45:02 -0400 |
| commit | e8577083cafdf0a164679db11ca9193605e4fffe (patch) | |
| tree | 7af390b3b1403b1a0de71e0ff3883135dc7e2ec5 | |
| parent | 9de24b16e83ca27322c09cde50648d7834820778 (diff) | |
| download | NetworkManager-e8577083cafdf0a164679db11ca9193605e4fffe.tar.gz | |
libnm-util: various NMSetting* property doc fixes/improvements
Fix up various issues with the docs for the NMSetting properties, and
pull in text from the GParamSpec docs where the GParamSpec docs were
better (or contained information that is necessary in the context of
nm-settings.5).
Also, consistently wrap all of the doc comments to the same width (80
columns).
26 files changed, 494 insertions, 386 deletions
diff --git a/libnm-util/nm-setting-8021x.c b/libnm-util/nm-setting-8021x.c index ef5b1c26ab..d85b87b891 100644 --- a/libnm-util/nm-setting-8021x.c +++ b/libnm-util/nm-setting-8021x.c @@ -3136,9 +3136,9 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * NMSetting8021x:eap: * * The allowed EAP method to be used when authenticating to the network with - * 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd" and - * "fast". Each method requires different configuration using the - * properties of this object; refer to wpa_supplicant documentation for the + * 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", + * and "fast". Each method requires different configuration using the + * properties of this setting; refer to wpa_supplicant documentation for the * allowed combinations. **/ g_object_class_install_property @@ -3158,8 +3158,8 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:identity: * - * Identity string for EAP authentication methods. Often the user's - * user or login name. + * Identity string for EAP authentication methods. Often the user's user or + * login name. **/ g_object_class_install_property (object_class, PROP_IDENTITY, @@ -3205,8 +3205,19 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * NMSetting8021x:ca-cert: * * Contains the CA certificate if used by the EAP method specified in the - * #NMSetting8021x:eap property. Setting this property directly is - * discouraged; use the nm_setting_802_1x_set_ca_cert() function instead. + * #NMSetting8021x:eap property. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. This + * property can be unset even if the EAP method supports CA certificates, + * but this allows man-in-the-middle attacks and is NOT recommended. + * + * Setting this property directly is discouraged; use the + * nm_setting_802_1x_set_ca_cert() function instead. **/ g_object_class_install_property (object_class, PROP_CA_CERT, @@ -3250,10 +3261,9 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:subject-match: * - * Substring to be matched against the subject of the certificate - * presented by the authentication server. When unset, no - * verification of the authentication server certificate's subject - * is performed. + * Substring to be matched against the subject of the certificate presented + * by the authentication server. When unset, no verification of the + * authentication server certificate's subject is performed. **/ g_object_class_install_property (object_class, PROP_SUBJECT_MATCH, @@ -3271,9 +3281,8 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * NMSetting8021x:altsubject-matches: * * List of strings to be matched against the altSubjectName of the - * certificate presented by the authentication server. If the list - * is empty, no verification of the server certificate's - * altSubjectName is performed. + * certificate presented by the authentication server. If the list is empty, + * no verification of the server certificate's altSubjectName is performed. **/ g_object_class_install_property (object_class, PROP_ALTSUBJECT_MATCHES, @@ -3292,8 +3301,17 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * NMSetting8021x:client-cert: * * Contains the client certificate if used by the EAP method specified in - * the #NMSetting8021x:eap property. Setting this property directly is - * discouraged; use the nm_setting_802_1x_set_client_cert() function instead. + * the #NMSetting8021x:eap property. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. + * + * Setting this property directly is discouraged; use the + * nm_setting_802_1x_set_client_cert() function instead. **/ g_object_class_install_property (object_class, PROP_CLIENT_CERT, @@ -3387,9 +3405,9 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * * Specifies the allowed "phase 2" inner non-EAP authentication methods when * an EAP method that uses an inner TLS tunnel is specified in the - * #NMSetting8021x:eap property. Recognized non-EAP phase2 methods are + * #NMSetting8021x:eap property. Recognized non-EAP "phase 2" methods are * "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". - * Each 'phase 2' inner method requires specific parameters for successful + * Each "phase 2" inner method requires specific parameters for successful * authentication; see the wpa_supplicant documentation for more details. **/ g_object_class_install_property @@ -3412,8 +3430,8 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * * Specifies the allowed "phase 2" inner EAP-based authentication methods * when an EAP method that uses an inner TLS tunnel is specified in the - * #NMSetting8021x:eap property. Recognized EAP-based phase2 methods are - * "md5", "mschapv2", "otp", "gtc", and "tls". Each 'phase 2' inner method + * #NMSetting8021x:eap property. Recognized EAP-based "phase 2" methods are + * "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method * requires specific parameters for successful authentication; see the * wpa_supplicant documentation for more details. **/ @@ -3435,8 +3453,19 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:phase2-ca-cert: * - * Contains the CA certificate if used by the EAP method specified in the - * #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap properties. + * Contains the "phase 2" CA certificate if used by the EAP method specified + * in the #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap + * properties. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. This + * property can be unset even if the EAP method supports CA certificates, + * but this allows man-in-the-middle attacks and is NOT recommended. + * * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_phase2_ca_cert() function instead. **/ @@ -3483,10 +3512,10 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:phase2-subject-match: * - * Substring to be matched against the subject of the certificate - * presented by the authentication server during the inner "phase - * 2" authentication. When unset, no verification of the - * authentication server certificate's subject is performed. + * Substring to be matched against the subject of the certificate presented + * by the authentication server during the inner "phase 2" + * authentication. When unset, no verification of the authentication server + * certificate's subject is performed. **/ g_object_class_install_property (object_class, PROP_PHASE2_SUBJECT_MATCH, @@ -3505,10 +3534,9 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * NMSetting8021x:phase2-altsubject-matches: * * List of strings to be matched against the altSubjectName of the - * certificate presented by the authentication server during the - * inner "phase 2" authentication. If the list is empty, no - * verification of the server certificate's altSubjectName is - * performed. + * certificate presented by the authentication server during the inner + * "phase 2" authentication. If the list is empty, no verification of the + * server certificate's altSubjectName is performed. **/ g_object_class_install_property (object_class, PROP_PHASE2_ALTSUBJECT_MATCHES, @@ -3528,9 +3556,20 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:phase2-client-cert: * - * Contains the client certificate if used by the EAP method specified in - * the #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap - * properties. Setting this property directly is discouraged; use the + * Contains the "phase 2" client certificate if used by the EAP method + * specified in the #NMSetting8021x:phase2-auth or + * #NMSetting8021x:phase2-autheap properties. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. This + * property can be unset even if the EAP method supports CA certificates, + * but this allows man-in-the-middle attacks and is NOT recommended. + * + * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_phase2_client_cert() function instead. **/ g_object_class_install_property @@ -3555,9 +3594,9 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:password: * - * Password used for EAP authentication methods. If both - * #NMSetting8021x:password and #NMSetting8021x:password-raw are - * specified, #NMSetting8021x:password is preferred. + * UTF-8 encoded password used for EAP authentication methods. If both the + * #NMSetting8021x:password property and the #NMSetting8021x:password-raw + * property are specified, #NMSetting8021x:password is preferred. **/ g_object_class_install_property (object_class, PROP_PASSWORD, @@ -3570,7 +3609,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:password-flags: * - * Flags indicating how to handle #NMSetting8021x:password:. + * Flags indicating how to handle the #NMSetting8021x:password property. **/ g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_802_1X_PASSWORD_FLAGS, @@ -3584,10 +3623,10 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:password-raw: * - * Password used for EAP authentication methods delivered as a - * UTF-8-encoded array of bytes. If both #NMSetting8021x:password - * and #NMSetting8021x:password-raw are specified, - * #NMSetting8021x:password is preferred. + * Password used for EAP authentication methods, given as a byte array to + * allow passwords in other encodings than UTF-8 to be used. If both the + * #NMSetting8021x:password property and the #NMSetting8021x:password-raw + * property are specified, #NMSetting8021x:password is preferred. **/ g_object_class_install_property (object_class, PROP_PASSWORD_RAW, @@ -3605,7 +3644,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:password-raw-flags: * - * Flags indicating how to handle #NMSetting8021x:password-raw:. + * Flags indicating how to handle the #NMSetting8021x:password-raw property. **/ g_object_class_install_property (object_class, PROP_PASSWORD_RAW_FLAGS, g_param_spec_uint (NM_SETTING_802_1X_PASSWORD_RAW_FLAGS, @@ -3619,8 +3658,25 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:private-key: * - * Contains the private key if the #NMSetting8021x:eap property is set to - * 'tls'. Setting this property directly is discouraged; use the + * Contains the private key when the #NMSetting8021x:eap property is set to + * "tls". + * + * Key data is specified using a "scheme"; two are currently supported: blob + * and path. When using the blob scheme and private keys, this property + * should be set to the key's encrypted PEM encoded data. When using private + * keys with the path scheme, this property should be set to the full UTF-8 + * encoded path of the key, prefixed with the string "file://" and ending + * with a terminating NUL byte. When using PKCS#12 format private keys and + * the blob scheme, this property should be set to the PKCS#12 data and the + * #NMSetting8021x:private-key-password property must be set to password + * used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files + * and the path scheme, this property should be set to the full UTF-8 + * encoded path of the key, prefixed with the string "file://" and and + * ending with a terminating NUL byte, and as with the blob scheme the + * "private-key-password" property must be set to the password used to + * decode the PKCS#12 private key and certificate. + * + * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_private_key() function instead. * * WARNING: #NMSetting8021x:private-key is not a "secret" property, and thus @@ -3662,9 +3718,9 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:private-key-password: * - * The password used to decrypt the private key specified in - * #NMSetting8021x:private-key when the private key either uses the path - * scheme, or if the private key is a PKCS#12 format key. Setting this + * The password used to decrypt the private key specified in the + * #NMSetting8021x:private-key property when the private key either uses the + * path scheme, or if the private key is a PKCS#12 format key. Setting this * property directly is not generally necessary except when returning * secrets to NetworkManager; it is generally set automatically when setting * the private key by the nm_setting_802_1x_set_private_key() function. @@ -3683,7 +3739,8 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:private-key-password-flags: * - * Flags indicating how to handle #NMSetting8021x:private-key-password:. + * Flags indicating how to handle the #NMSetting8021x:private-key-password + * property. **/ g_object_class_install_property (object_class, PROP_PRIVATE_KEY_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS, @@ -3698,11 +3755,26 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:phase2-private-key: * - * Private key data used by "phase 2" inner authentication methods. + * Contains the "phase 2" inner private key when the + * #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap property is + * set to "tls". + * + * Key data is specified using a "scheme"; two are currently supported: blob + * and path. When using the blob scheme and private keys, this property + * should be set to the key's encrypted PEM encoded data. When using private + * keys with the path scheme, this property should be set to the full UTF-8 + * encoded path of the key, prefixed with the string "file://" and ending + * with a terminating NUL byte. When using PKCS#12 format private keys and + * the blob scheme, this property should be set to the PKCS#12 data and the + * #NMSetting8021x:phase2-private-key-password property must be set to + * password used to decrypt the PKCS#12 certificate and key. When using + * PKCS#12 files and the path scheme, this property should be set to the + * full UTF-8 encoded path of the key, prefixed with the string "file://" + * and and ending with a terminating NUL byte, and as with the blob scheme + * the #NMSetting8021x:phase2-private-key-password property must be set to + * the password used to decode the PKCS#12 private key and certificate. * - * Contains the "phase 2" inner private key if the #NMSetting8021x:phase2-auth - * or #NMSetting8021x:phase2-autheap property is set to 'tls'. Setting this - * property directly is discouraged; use the + * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_phase2_private_key() function instead. **/ g_object_class_install_property @@ -3739,12 +3811,12 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:phase2-private-key-password: * - * The password used to decrypt the private key specified in - * #NMSetting8021x:phase2-private-key when the private key either uses the - * path scheme, or if the private key is a PKCS#12 format key. Setting this - * property directly is not generally necessary except when returning - * secrets to NetworkManager; it is generally set automatically when setting - * the private key by the nm_setting_802_1x_set_phase2_private_key() function. + * The password used to decrypt the "phase 2" private key specified in the + * #NMSetting8021x:phase2-private-key property when the private key either + * uses the path scheme, or is a PKCS#12 format key. Setting this property + * directly is not generally necessary except when returning secrets to + * NetworkManager; it is generally set automatically when setting the + * private key by the nm_setting_802_1x_set_phase2_private_key() function. **/ g_object_class_install_property (object_class, PROP_PHASE2_PRIVATE_KEY_PASSWORD, @@ -3760,7 +3832,8 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:phase2-private-key-password-flags: * - * Flags indicating how to handle #NMSetting8021x:phase2-private-key-password:. + * Flags indicating how to handle the + * #NMSetting8021x:phase2-private-key-password property. **/ g_object_class_install_property (object_class, PROP_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, @@ -3788,7 +3861,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) /** * NMSetting8021x:pin-flags: * - * Flags indicating how to handle #NMSetting8021x:pin:. + * Flags indicating how to handle the #NMSetting8021x:pin property. **/ g_object_class_install_property (object_class, PROP_PIN_FLAGS, g_param_spec_uint (NM_SETTING_802_1X_PIN_FLAGS, @@ -3806,8 +3879,8 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * #NMSetting8021x:phase2-ca-path properties using the system CA directory * specified at configure time with the --system-ca-path switch. The * certificates in this directory are added to the verification chain in - * addition to any certificates specified by the #NMSetting8021x:ca-cert - * and #NMSetting8021x:phase2-ca-cert properties. + * addition to any certificates specified by the #NMSetting8021x:ca-cert and + * #NMSetting8021x:phase2-ca-cert properties. **/ g_object_class_install_property (object_class, PROP_SYSTEM_CA_CERTS, diff --git a/libnm-util/nm-setting-adsl.c b/libnm-util/nm-setting-adsl.c index 50b0b225af..00cbb4aff1 100644 --- a/libnm-util/nm-setting-adsl.c +++ b/libnm-util/nm-setting-adsl.c @@ -409,7 +409,7 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) /** * NMSettingAdsl:password-flags: * - * Flags indicating how to handle #NMSettingAdsl:password:. + * Flags indicating how to handle the #NMSettingAdsl:password property. **/ g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_ADSL_PASSWORD_FLAGS, @@ -423,7 +423,7 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) /** * NMSettingAdsl:protocol: * - * ADSL connection protocol, can be pppoa, pppoe or ipoatm. + * ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". **/ g_object_class_install_property (object_class, PROP_PROTOCOL, @@ -436,7 +436,7 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) /** * NMSettingAdsl:encapsulation: * - * ADSL connection encapsulation, can be vcmux or llc. + * Encapsulation of ADSL connection. Can be "vcmux" or "llc". **/ g_object_class_install_property (object_class, PROP_ENCAPSULATION, @@ -449,7 +449,7 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) /** * NMSettingAdsl:vpi: * - * ADSL connection vpi. + * VPI of ADSL connection **/ g_object_class_install_property (object_class, PROP_VPI, @@ -462,7 +462,7 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) /** * NMSettingAdsl:vci: * - * ADSL connection vci. + * VCI of ADSL connection **/ g_object_class_install_property (object_class, PROP_VCI, diff --git a/libnm-util/nm-setting-bluetooth.c b/libnm-util/nm-setting-bluetooth.c index d568c01e36..5c13257c43 100644 --- a/libnm-util/nm-setting-bluetooth.c +++ b/libnm-util/nm-setting-bluetooth.c @@ -288,7 +288,7 @@ nm_setting_bluetooth_class_init (NMSettingBluetoothClass *setting_class) /** * NMSettingBluetooth:type: * - * Either 'dun' for Dial-Up Networking connections or 'panu' for Personal + * Either "dun" for Dial-Up Networking connections or "panu" for Personal * Area Networking connections to devices supporting the NAP profile. **/ g_object_class_install_property diff --git a/libnm-util/nm-setting-bond.c b/libnm-util/nm-setting-bond.c index c17fdbdcd5..5f919027d0 100644 --- a/libnm-util/nm-setting-bond.c +++ b/libnm-util/nm-setting-bond.c @@ -804,9 +804,9 @@ nm_setting_bond_class_init (NMSettingBondClass *setting_class) /** * NMSettingBond:options: * - * Dictionary of key/value pairs of bonding options. Both keys - * and values must be strings. Option names must contain only - * alphanumeric characters (ie, [a-zA-Z0-9]). + * Dictionary of key/value pairs of bonding options. Both keys and values + * must be strings. Option names must contain only alphanumeric characters + * (ie, [a-zA-Z0-9]). **/ g_object_class_install_property (object_class, PROP_OPTIONS, diff --git a/libnm-util/nm-setting-bridge-port.c b/libnm-util/nm-setting-bridge-port.c index 0a82fa692b..64be566276 100644 --- a/libnm-util/nm-setting-bridge-port.c +++ b/libnm-util/nm-setting-bridge-port.c @@ -273,7 +273,8 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class) /** * NMSettingBridgePort:path-cost: * - * The Spanning Tree Protocol (STP) port cost for destinations via this port. + * The Spanning Tree Protocol (STP) port cost for destinations via this + * port. * * Since: 0.9.8 **/ @@ -289,7 +290,7 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class) /** * NMSettingBridgePort:hairpin-mode: * - * Enables or disabled 'hairpin mode' for the port, which allows frames to + * Enables or disabled "hairpin mode" for the port, which allows frames to * be sent back out through the port the frame was received on. * * Since: 0.9.8 diff --git a/libnm-util/nm-setting-bridge.c b/libnm-util/nm-setting-bridge.c index 1860d7f2f6..0908573d25 100644 --- a/libnm-util/nm-setting-bridge.c +++ b/libnm-util/nm-setting-bridge.c @@ -462,7 +462,7 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) /** * NMSettingBridge:interface-name: * - * The name of the virtual in-kernel briding network interface + * The name of the virtual in-kernel bridging network interface * * Since: 0.9.8 **/ @@ -477,9 +477,9 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) /** * NMSettingBridge:mac-address: * - * If specified, the MAC address of bridge. When creating a new bridge, this MAC address - * will be set. When matching an existing (outside NetworkManager created) bridge, this - * MAC address must match. + * If specified, the MAC address of bridge. When creating a new bridge, this + * MAC address will be set. When matching an existing (outside + * NetworkManager created) bridge, this MAC address must match. * * Since: 0.9.10 **/ diff --git a/libnm-util/nm-setting-cdma.c b/libnm-util/nm-setting-cdma.c index 8b4752d146..7acfe85201 100644 --- a/libnm-util/nm-setting-cdma.c +++ b/libnm-util/nm-setting-cdma.c @@ -354,7 +354,7 @@ nm_setting_cdma_class_init (NMSettingCdmaClass *setting_class) /** * NMSettingCdma:password-flags: * - * Flags indicating how to handle #NMSettingCdma:password:. + * Flags indicating how to handle the #NMSettingCdma:password property. **/ g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_CDMA_PASSWORD_FLAGS, diff --git a/libnm-util/nm-setting-connection.c b/libnm-util/nm-setting-connection.c index 50dc6c59fd..56e87a4dff 100644 --- a/libnm-util/nm-setting-connection.c +++ b/libnm-util/nm-setting-connection.c @@ -1098,8 +1098,8 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:id: * - * A human readable unique idenfier for the connection, like "Work Wi-Fi" or - * "T-Mobile 3G". + * A human readable unique identifier for the connection, like "Work Wi-Fi" + * or "T-Mobile 3G". **/ g_object_class_install_property (object_class, PROP_ID, @@ -1114,16 +1114,16 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:uuid: * - * A universally unique idenfier for the connection, for example generated - * with libuuid. Should be assigned when the connection is created, and + * A universally unique identifier for the connection, for example generated + * with libuuid. It should be assigned when the connection is created, and * never changed as long as the connection still applies to the same - * network. For example, should not be changed when the - * #NMSettingConnection:id or #NMSettingIP4Config changes, but might need - * to be re-created when the Wi-Fi SSID, mobile broadband network provider, - * or #NMSettingConnection:type changes. + * network. For example, it should not be changed when the + * #NMSettingConnection:id property or #NMSettingIP4Config changes, but + * might need to be re-created when the Wi-Fi SSID, mobile broadband network + * provider, or #NMSettingConnection:type property changes. * - * The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' - * (ie, contains only hexadecimal characters and '-'). A suitable UUID may + * The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" + * (ie, contains only hexadecimal characters and "-"). A suitable UUID may * be generated by nm_utils_uuid_generate() or * nm_utils_uuid_generate_from_string(). **/ @@ -1147,16 +1147,15 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:interface-name: * - * The name of the network interface this connection is bound to. If - * not set, then the connection can be attached to any interface of the + * The name of the network interface this connection is bound to. If not + * set, then the connection can be attached to any interface of the * appropriate type (subject to restrictions imposed by other settings). * - * For connection types where interface names cannot easily be - * made persistent (e.g. mobile broadband or USB Ethernet), this - * property should not be used. Setting this property restricts - * the interfaces a connection can be used with, and if interface - * names change or are reordered the connection may be applied to - * the wrong interface. + * For connection types where interface names cannot easily be made + * persistent (e.g. mobile broadband or USB Ethernet), this property should + * not be used. Setting this property restricts the interfaces a connection + * can be used with, and if interface names change or are reordered the + * connection may be applied to the wrong interface. * * Since: 0.9.10 **/ @@ -1181,10 +1180,11 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:type: * - * The general hardware type of the device used for the network connection, - * contains the name of the #NMSetting object that describes that hardware - * type's parameters. For example, for Wi-Fi devices, the name of the - * #NMSettingWireless setting. + * Base type of the connection. For hardware-dependent connections, should + * contain the setting name of the hardware-type specific setting (ie, + * "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for + * non-hardware dependent connections like VPN or otherwise, should contain + * the setting name of that setting type (ie, "vpn" or "bridge", etc). **/ g_object_class_install_property (object_class, PROP_TYPE, @@ -1207,15 +1207,13 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) * connection. If this is %NULL or empty, all users are allowed to access * this connection. Otherwise a user is allowed to access this connection * if and only if they are in this list. Each entry is of the form - * "[type]:[id]:[reserved]", for example: + * "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". * - * user:dcbw:blah - * - * At this time only the 'user' [type] is allowed. Any other values are + * At this time only the "user" [type] is allowed. Any other values are * ignored and reserved for future use. [id] is the username that this - * permission refers to, which may not contain the ':' character. Any - * [reserved] information present must be ignored and is reserved for - * future use. All of [type], [id], and [reserved] must be valid UTF-8. + * permission refers to, which may not contain the ":" character. Any + * [reserved] information present must be ignored and is reserved for future + * use. All of [type], [id], and [reserved] must be valid UTF-8. */ g_object_class_install_property (object_class, PROP_PERMISSIONS, @@ -1245,7 +1243,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) * Whether or not the connection should be automatically connected by * NetworkManager when the resources for the connection are available. * %TRUE to automatically activate the connection, %FALSE to require manual - * intervention to activate the connection. Defaults to %TRUE. + * intervention to activate the connection. **/ g_object_class_install_property (object_class, PROP_AUTOCONNECT, @@ -1263,6 +1261,11 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) * * The time, in seconds since the Unix Epoch, that the connection was last * _successfully_ fully activated. + * + * NetworkManager updates the connection timestamp periodically when the + * connection is active to ensure that an active connection has the latest + * timestamp. The property is only meant for reading (changes to this + * property will not be preserved). **/ g_object_class_install_property (object_class, PROP_TIMESTAMP, @@ -1281,8 +1284,8 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) * NMSettingConnection:read-only: * * %FALSE if the connection can be modified using the provided settings - * service's D-Bus interface with the right privileges, or %TRUE - * if the connection is read-only and cannot be modified. + * service's D-Bus interface with the right privileges, or %TRUE if the + * connection is read-only and cannot be modified. **/ g_object_class_install_property (object_class, PROP_READ_ONLY, @@ -1298,10 +1301,10 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:zone: * - * The trust level of a the connection. - * Free form case-insensitive string (for example "Home", "Work", "Public"). - * %NULL or unspecified zone means the connection will be placed in the - * default zone as defined by the firewall. + * The trust level of a the connection. Free form case-insensitive string + * (for example "Home", "Work", "Public"). %NULL or unspecified zone means + * the connection will be placed in the default zone as defined by the + * firewall. **/ g_object_class_install_property (object_class, PROP_ZONE, @@ -1333,8 +1336,9 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:slave-type: * - * Setting name describing the type of slave device (ie - * #NM_SETTING_BOND_SETTING_NAME) or NULL if this connection is not a slave. + * Setting name of the device type of this slave's master connection (eg, + * %NM_SETTING_BOND_SETTING_NAME), or %NULL if this connection is not a + * slave. **/ g_object_class_install_property (object_class, PROP_SLAVE_TYPE, @@ -1349,8 +1353,9 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:secondaries: * - * List of connection UUIDs that should be activated when the base connection - * itself is activated. Currently only VPN connections are supported. + * List of connection UUIDs that should be activated when the base + * connection itself is activated. Currently only VPN connections are + * supported. * * Since: 0.9.8 **/ diff --git a/libnm-util/nm-setting-dcb.c b/libnm-util/nm-setting-dcb.c index d7143b7435..54b115dd4b 100644 --- a/libnm-util/nm-setting-dcb.c +++ b/libnm-util/nm-setting-dcb.c @@ -961,7 +961,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-fcoe-flags: * - * Specifies the #NMSettingDcbFlags for the DCB FCoE application. + * Specifies the #NMSettingDcbFlags for the DCB FCoE application. Flags may + * be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ @@ -979,8 +981,8 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) * NMSettingDcb:app-fcoe-priority: * * The highest User Priority (0 - 7) which FCoE frames should use, or -1 for - * default priority. Only used when #NMSettingDcb:app-fcoe-flags includes - * %NM_SETTING_DCB_FLAG_ENABLE. + * default priority. Only used when the #NMSettingDcb:app-fcoe-flags + * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag. * * Since: 0.9.10 **/ @@ -998,8 +1000,8 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-fcoe-mode: * - * The FCoE controller mode; either %NM_SETTING_DCB_FCOE_MODE_FABRIC (default) - * or %NM_SETTING_DCB_FCOE_MODE_VN2VN. + * The FCoE controller mode; either %NM_SETTING_DCB_FCOE_MODE_FABRIC + * (default) or %NM_SETTING_DCB_FCOE_MODE_VN2VN. * * Since: 0.9.10 **/ @@ -1015,7 +1017,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-iscsi-flags: * - * Specifies the #NMSettingDcbFlags for the DCB iSCSI application. + * Specifies the #NMSettingDcbFlags for the DCB iSCSI application. Flags + * may be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ @@ -1032,8 +1036,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-iscsi-priority: * - * The highest User Priority (0 - 7) which iSCSI frames should use. Only - * used when #NMSettingDcb:app-iscsi-flags includes %NM_SETTING_DCB_FLAG_ENABLE. + * The highest User Priority (0 - 7) which iSCSI frames should use, or -1 + * for default priority. Only used when the #NMSettingDcb:app-iscsi-flags + * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag. * * Since: 0.9.10 **/ @@ -1051,7 +1056,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-fip-flags: * - * Specifies the #NMSettingDcbFlags for the DCB FIP application. + * Specifies the #NMSettingDcbFlags for the DCB FIP application. Flags may + * be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ @@ -1068,8 +1075,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-fip-priority: * - * The highest User Priority (0 - 7) which FIP frames should use. Only - * used when #NMSettingDcb:app-fip-flags includes %NM_SETTING_DCB_FLAG_ENABLE. + * The highest User Priority (0 - 7) which FIP frames should use, or -1 for + * default priority. Only used when the #NMSettingDcb:app-fip-flags + * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag. * * Since: 0.9.10 **/ @@ -1088,6 +1096,8 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) * NMSettingDcb:priority-flow-control-flags: * * Specifies the #NMSettingDcbFlags for DCB Priority Flow Control (PFC). + * Flags may be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ @@ -1104,10 +1114,10 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:priority-flow-control: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates whether or not the - * corresponding priority should transmit priority pause. Allowed values - * are 0 (do not transmit pause) and 1 (transmit pause). + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates whether or not the corresponding + * priority should transmit priority pause. Allowed values are 0 (do not + * transmit pause) and 1 (transmit pause). * * Since: 0.9.10 **/ @@ -1127,7 +1137,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:priority-group-flags: * - * Specifies the #NMSettingDcbFlags for DCB Priority Groups. + * Specifies the #NMSettingDcbFlags for DCB Priority Groups. Flags may be + * any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ @@ -1144,10 +1156,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:priority-group-id: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates the Priority Group ID. - * Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted - * group. + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates the Priority Group ID. Allowed + * Priority Group ID values are 0 - 7 or 15 for the unrestricted group. * * Since: 0.9.10 **/ @@ -1167,9 +1178,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) * NMSettingDcb:priority-group-bandwidth: * * An array of 8 uint values, where the array index corresponds to the - * Priority Group ID (0 - 7) and the value indicates the percentage of - * link bandwidth allocated to that group. Allowed values are 0 - 100, - * and the sum of all values must total 100 percent. + * Priority Group ID (0 - 7) and the value indicates the percentage of link + * bandwidth allocated to that group. Allowed values are 0 - 100, and the + * sum of all values must total 100 percent. * * Since: 0.9.10 **/ @@ -1188,11 +1199,11 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:priority-bandwidth: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates the percentage of bandwidth - * of the priority's assigned group that the priority may use. The sum of - * all percentages for priorities which belong to the same group must total - * 100 percent. + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates the percentage of bandwidth of + * the priority's assigned group that the priority may use. The sum of all + * percentages for priorities which belong to the same group must total 100 + * percent. * * Since: 0.9.10 **/ @@ -1212,11 +1223,11 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:priority-strict-bandwidth: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates whether or not the - * priority may use all of the bandwidth allocated to its assigned group. - * Allowed values are 0 (the priority may not utilize all bandwidth) or - * 1 (the priority may utilize all bandwidth). + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates whether or not the priority may + * use all of the bandwidth allocated to its assigned group. Allowed values + * are 0 (the priority may not utilize all bandwidth) or 1 (the priority may + * utilize all bandwidth). * * Since: 0.9.10 **/ @@ -1237,9 +1248,9 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:priority-traffic-class: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates the traffic class (0 - 7) - * to which the priority is mapped. + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates the traffic class (0 - 7) to + * which the priority is mapped. * * Since: 0.9.10 **/ diff --git a/libnm-util/nm-setting-gsm.c b/libnm-util/nm-setting-gsm.c index 44f0e0d916..f96a997b8b 100644 --- a/libnm-util/nm-setting-gsm.c +++ b/libnm-util/nm-setting-gsm.c @@ -602,7 +602,7 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) /** * NMSettingGsm:password-flags: * - * Flags indicating how to handle #NMSettingGsm:password:. + * Flags indicating how to handle the #NMSettingGsm:password property. **/ g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_GSM_PASSWORD_FLAGS, @@ -621,8 +621,8 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) * the user will be billed for their network usage and whether the user has * access to the Internet or just a provider-specific walled-garden, so it * is important to use the correct APN for the user's mobile broadband plan. - * The APN may only be composed of the characters a-z, 0-9, ., and - per - * GSM 03.60 Section 14.9. + * The APN may only be composed of the characters a-z, 0-9, ., and - per GSM + * 03.60 Section 14.9. **/ g_object_class_install_property (object_class, PROP_APN, @@ -667,11 +667,17 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) * NMSettingGsm:network-type: * * Network preference to force the device to only use specific network - * technologies. Permitted values are those specified by - * #NMSettingGsmNetworkType. Note that not all devices allow network + * technologies. The permitted values are %NM_SETTING_GSM_NETWORK_TYPE_ANY, + * %NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA, + * %NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE, + * %NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA, + * %NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE, + * %NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G, and + * %NM_SETTING_GSM_NETWORK_TYPE_4G. Note that not all devices allow network * preference control. * - * Deprecated: 0.9.10: No longer used. Network type setting should be done talking to ModemManager directly. + * Deprecated: 0.9.10: No longer used. Network type setting should be done + * by talking to ModemManager directly. **/ g_object_class_install_property (object_class, PROP_NETWORK_TYPE, @@ -696,7 +702,8 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) * frequency band control. Permitted values are those specified by * #NMSettingGsmNetworkBand. * - * Deprecated: 0.9.10: No longer used. Band setting should be done talking to ModemManager directly. + * Deprecated: 0.9.10: No longer used. Band setting should be done by + * talking to ModemManager directly. **/ g_object_class_install_property (object_class, PROP_ALLOWED_BANDS, @@ -715,8 +722,8 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) * NMSettingGsm:pin: * * If the SIM is locked with a PIN it must be unlocked before any other - * operations are requested. Specify the PIN here to allow operation of - * the device. + * operations are requested. Specify the PIN here to allow operation of the + * device. **/ g_object_class_install_property (object_class, PROP_PIN, @@ -731,7 +738,7 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) /** * NMSettingGsm:pin-flags: * - * Flags indicating how to handle #NMSettingGsm:pin. + * Flags indicating how to handle the #NMSettingGsm:pin property. **/ g_object_class_install_property (object_class, PROP_PIN_FLAGS, g_param_spec_uint (NM_SETTING_GSM_PIN_FLAGS, diff --git a/libnm-util/nm-setting-infiniband.c b/libnm-util/nm-setting-infiniband.c index 62ed53f13a..5af5044836 100644 --- a/libnm-util/nm-setting-infiniband.c +++ b/libnm-util/nm-setting-infiniband.c @@ -353,9 +353,9 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class) /** * NMSettingInfiniband:mac-address: * - * If specified, this connection will only apply to the IPoIB - * device whose permanent MAC address matches. This property does - * not change the MAC address of the device (i.e. MAC spoofing). + * If specified, this connection will only apply to the IPoIB device whose + * permanent MAC address matches. This property does not change the MAC + * address of the device (i.e. MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, @@ -387,8 +387,8 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class) /** * NMSettingInfiniband:transport-mode: * - * The IP-over-InfiniBand transport mode. Either 'datagram' or - * 'connected'. + * The IP-over-InfiniBand transport mode. Either "datagram" or + * "connected". **/ g_object_class_install_property (object_class, PROP_TRANSPORT_MODE, @@ -401,10 +401,10 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class) /** * NMSettingInfiniband:p-key: * - * The InfiniBand P_Key to use for this device. A value of -1 - * means to use the default P_Key (aka "the P_Key at index 0"). - * Otherwise it is a 16-bit unsigned integer, whose high bit - * is set if it is a "full membership" P_Key. + * The InfiniBand P_Key to use for this device. A value of -1 means to use + * the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit + * unsigned integer, whose high bit is set if it is a "full membership" + * P_Key. **/ g_object_class_install_property (object_class, PROP_P_KEY, @@ -418,8 +418,8 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class) /** * NMSettingInfiniband:parent: * - * The interface name of the parent device of this device. Normally - * %NULL, but if #NMSettingInfiniband:p_key is set, then you must + * The interface name of the parent device of this device. Normally %NULL, + * but if the #NMSettingInfiniband:p_key property is set, then you must * specify the base device by setting either this property or * #NMSettingInfiniband:mac-address. **/ diff --git a/libnm-util/nm-setting-ip4-config.c b/libnm-util/nm-setting-ip4-config.c index cb24e5f5c1..863696912a 100644 --- a/libnm-util/nm-setting-ip4-config.c +++ b/libnm-util/nm-setting-ip4-config.c @@ -1221,17 +1221,17 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:method: * - * IPv4 configuration method. If 'auto' is specified then the appropriate + * IPv4 configuration method. If "auto" is specified then the appropriate * automatic method (DHCP, PPP, etc) is used for the interface and most - * other properties can be left unset. If 'link-local' is specified, then a + * other properties can be left unset. If "link-local" is specified, then a * link-local address in the 169.254/16 range will be assigned to the - * interface. If 'manual' is specified, static IP addressing is used and at - * least one IP address must be given in the 'addresses' property. If - * 'shared' is specified (indicating that this connection will provide + * interface. If "manual" is specified, static IP addressing is used and at + * least one IP address must be given in the "addresses" property. If + * "shared" is specified (indicating that this connection will provide * network access to other computers) then the interface is assigned an * address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server * are started, and the interface is NAT-ed to the current default network - * connection. 'disabled' means IPv4 will not be used on this connection. + * connection. "disabled" means IPv4 will not be used on this connection. * This property must be set. **/ g_object_class_install_property @@ -1261,12 +1261,12 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:dns: * - * List of DNS servers (network byte order). For the 'auto' method, these + * List of DNS servers (network byte order). For the "auto" method, these * DNS servers are appended to those (if any) returned by automatic - * configuration. DNS servers cannot be used with the 'shared', 'link-local', - * or 'disabled' methods as there is no upstream network. In all other - * methods, these DNS servers are used as the only DNS servers for this - * connection. + * configuration. DNS servers cannot be used with the "shared", + * "link-local", or "disabled" methods as there is no upstream network. In + * all other methods, these DNS servers are used as the only DNS servers for + * this connection. **/ g_object_class_install_property (object_class, PROP_DNS, @@ -1286,9 +1286,9 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:dns-search: * - * List of DNS search domains. For the 'auto' method, these search domains + * List of DNS search domains. For the "auto" method, these search domains * are appended to those returned by automatic configuration. Search domains - * cannot be used with the 'shared', 'link-local', or 'disabled' methods as + * cannot be used with the "shared", "link-local", or "disabled" methods as * there is no upstream network. In all other methods, these search domains * are used as the only search domains for this connection. **/ @@ -1314,9 +1314,9 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) * composed of 3 32-bit values; the first being the IPv4 address (network * byte order), the second the prefix (1 - 32), and last the IPv4 gateway * (network byte order). The gateway may be left as 0 if no gateway exists - * for that subnet. For the 'auto' method, given IP addresses are appended + * for that subnet. For the "auto" method, given IP addresses are appended * to those returned by automatic configuration. Addresses cannot be used - * with the 'shared', 'link-local', or 'disabled' methods as addressing is + * with the "shared", "link-local", or "disabled" methods as addressing is * either automatic or disabled with these methods. **/ g_object_class_install_property @@ -1349,14 +1349,14 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:routes: * - * Array of IPv4 route structures. Each IPv4 route structure is composed - * of 4 32-bit values; the first being the destination IPv4 network or - * address (network byte order), the second the destination network or - * address prefix (1 - 32), the third being the next-hop (network byte - * order) if any, and the fourth being the route metric. For the 'auto' - * method, given IP routes are appended to those returned by automatic - * configuration. Routes cannot be used with the 'shared', 'link-local', - * or 'disabled' methods because there is no upstream network. + * Array of IPv4 route structures. Each IPv4 route structure is composed of + * 4 32-bit values; the first being the destination IPv4 network or address + * (network byte order), the second the destination network or address + * prefix (1 - 32), the third being the next-hop (network byte order) if + * any, and the fourth being the route metric. For the "auto" method, given + * IP routes are appended to those returned by automatic configuration. + * Routes cannot be used with the "shared", "link-local", or "disabled" + * methods because there is no upstream network. **/ g_object_class_install_property (object_class, PROP_ROUTES, @@ -1380,9 +1380,9 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:ignore-auto-routes: * - * When the method is set to 'auto' and this property to %TRUE, automatically - * configured routes are ignored and only routes specified in - * #NMSettingIP4Config:routes, if any, are used. + * When the method is set to "auto" and this property to %TRUE, + * automatically configured routes are ignored and only routes specified in + * the #NMSettingIP4Config:routes property, if any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_ROUTES, @@ -1398,10 +1398,11 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:ignore-auto-dns: * - * When the method is set to 'auto' and this property to %TRUE, automatically - * configured nameservers and search domains are ignored and only nameservers - * and search domains specified in #NMSettingIP4Config:dns and - * #NMSettingIP4Config:dns-search, if any, are used. + * When the method is set to "auto" and this property to %TRUE, + * automatically configured nameservers and search domains are ignored and + * only nameservers and search domains specified in the + * #NMSettingIP4Config:dns and #NMSettingIP4Config:dns-search properties, if + * any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_DNS, @@ -1436,9 +1437,9 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) * * If %TRUE, a hostname is sent to the DHCP server when acquiring a lease. * Some DHCP servers use this hostname to update DNS databases, essentially - * providing a static hostname for the computer. If - * #NMSettingIP4Config:dhcp-hostname is empty and this property is TRUE, - * the current persistent hostname of the computer is sent. + * providing a static hostname for the computer. If the + * #NMSettingIP4Config:dhcp-hostname property is empty and this property is + * %TRUE, the current persistent hostname of the computer is sent. **/ g_object_class_install_property (object_class, PROP_DHCP_SEND_HOSTNAME, @@ -1490,11 +1491,11 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) * NMSettingIP4Config:may-fail: * * If %TRUE, allow overall network configuration to proceed even if IPv4 - * configuration times out. Note that at least one IP configuration - * must succeed or overall network configuration will still fail. For - * example, in IPv6-only networks, setting this property to %TRUE allows - * the overall network configuration to succeed if IPv4 configuration fails - * but IPv6 configuration completes successfully. + * configuration times out. Note that at least one IP configuration must + * succeed or overall network configuration will still fail. For example, + * in IPv6-only networks, setting this property to %TRUE allows the overall + * network configuration to succeed if IPv4 configuration fails but IPv6 + * configuration completes successfully. **/ g_object_class_install_property (object_class, PROP_MAY_FAIL, diff --git a/libnm-util/nm-setting-ip6-config.c b/libnm-util/nm-setting-ip6-config.c index 73dbea28cc..b027ee96a9 100644 --- a/libnm-util/nm-setting-ip6-config.c +++ b/libnm-util/nm-setting-ip6-config.c @@ -1019,16 +1019,16 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:method: * - * IPv6 configuration method. If 'auto' is specified then the appropriate - * automatic method (DHCP, PPP, advertisement, etc) is used for the - * interface and most other properties can be left unset. To force the use - * of DHCP only, specify 'dhcp'; this method is only valid for Ethernet- - * based hardware. If 'link-local' is specified, then an IPv6 link-local - * address will be assigned to the interface. If 'manual' is specified, - * static IP addressing is used and at least one IP address must be given - * in the 'addresses' property. If 'ignore' is specified, IPv6 - * configuration is not done. This property must be set. Note: the 'shared' - * method is not yet supported. + * IPv6 configuration method. If "auto" is specified then the appropriate + * automatic method (PPP, router advertisement, etc) is used for the device + * and most other properties can be left unset. To force the use of DHCP + * only, specify "dhcp"; this method is only valid for Ethernet- based + * hardware. If "link-local" is specified, then an IPv6 link-local address + * will be assigned to the interface. If "manual" is specified, static IP + * addressing is used and at least one IP address must be given in the + * "addresses" property. If "ignore" is specified, IPv6 configuration is + * not done. This property must be set. Note: the "shared" method is not + * yet supported. **/ g_object_class_install_property (object_class, PROP_METHOD, @@ -1054,7 +1054,8 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:dhcp-hostname: * - * The specified name will be sent to the DHCP server when acquiring a lease. + * The specified name will be sent to the DHCP server when acquiring a + * lease. * * Since: 0.9.8 **/ @@ -1072,10 +1073,10 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) * * Array of DNS servers, where each member of the array is a byte array * containing the IPv6 address of the DNS server (in network byte order). - * For the 'auto' method, these DNS servers are appended to those (if any) - * returned by automatic configuration. DNS servers cannot be used with - * the 'shared' or 'link-local' methods as there is no usptream network. In - * all other methods, these DNS servers are used as the only DNS servers for + * For the "auto" method, these DNS servers are appended to those (if any) + * returned by automatic configuration. DNS servers cannot be used with the + * "shared" or "link-local" methods as there is no usptream network. In all + * other methods, these DNS servers are used as the only DNS servers for * this connection. **/ g_object_class_install_property @@ -1098,11 +1099,11 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:dns-search: * - * List of DNS search domains. For the 'auto' method, these search domains + * List of DNS search domains. For the "auto" method, these search domains * are appended to those returned by automatic configuration. Search domains - * cannot be used with the 'shared' or 'link-local' methods as there is no - * upstream network. In all other methods, these search domains are used - * as the only search domains for this connection. + * cannot be used with the "shared" or "link-local" methods as there is no + * upstream network. In all other methods, these search domains are used as + * the only search domains for this connection. **/ g_object_class_install_property (object_class, PROP_DNS_SEARCH, @@ -1127,10 +1128,10 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) * address (network byte order), the second a 32-bit integer containing the * IPv6 address prefix, and the third a byte array containing the IPv6 * address (network byte order) of the gateway associated with this address, - * if any. If no gateway is given, the third element should be given as - * all zeros. For the 'auto' method, given IP addresses are appended to - * those returned by automatic configuration. Addresses cannot be used with - * the 'shared' or 'link-local' methods as the interface is automatically + * if any. If no gateway is given, the third element should be given as all + * zeros. For the "auto" method, given IP addresses are appended to those + * returned by automatic configuration. Addresses cannot be used with the + * "shared" or "link-local" methods as the interface is automatically * assigned an address with these methods. **/ g_object_class_install_property @@ -1158,14 +1159,14 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:routes: * - * Array of IPv6 route structures. Each IPv6 route structure is composed - * of 4 members; the first being the destination IPv6 network or - * address (network byte order) as a byte array, the second the destination - * network or address IPv6 prefix, the third being the next-hop IPv6 address + * Array of IPv6 route structures. Each IPv6 route structure is composed of + * 4 members; the first being the destination IPv6 network or address + * (network byte order) as a byte array, the second the destination network + * or address IPv6 prefix, the third being the next-hop IPv6 address * (network byte order) if any, and the fourth being the route metric. For - * the 'auto' method, given IP routes are appended to those returned by - * automatic configuration. Routes cannot be used with the 'shared' or - * 'link-local' methods because there is no upstream network. + * the "auto" method, given IP routes are appended to those returned by + * automatic configuration. Routes cannot be used with the "shared" or + * "link-local" methods because there is no upstream network. **/ g_object_class_install_property (object_class, PROP_ROUTES, @@ -1189,9 +1190,9 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:ignore-auto-routes: * - * When the method is set to 'auto' or 'dhcp' and this property is set to + * When the method is set to "auto" or "dhcp" and this property is set to * %TRUE, automatically configured routes are ignored and only routes - * specified in #NMSettingIP6Config:routes, if any, are used. + * specified in the #NMSettingIP6Config:routes property, if any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_ROUTES, @@ -1207,11 +1208,11 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:ignore-auto-dns: * - * When the method is set to 'auto' or 'dhcp' and this property is set to - * %TRUE, automatically configured nameservers and search domains are ignored - * and only nameservers and search domains specified in - * #NMSettingIP6Config:dns and #NMSettingIP6Config:dns-search, if any, are - * used. + * When the method is set to "auto" or "dhcp" and this property is set to + * %TRUE, automatically configured nameservers and search domains are + * ignored and only nameservers and search domains specified in the + * #NMSettingIP6Config:dns and #NMSettingIP6Config:dns-search properties, if + * any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_DNS, @@ -1229,7 +1230,8 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) * NMSettingIP6Config:never-default: * * If %TRUE, this connection will never be the default IPv6 connection, - * meaning it will never be assigned the default IPv6 route by NetworkManager. + * meaning it will never be assigned the default IPv6 route by + * NetworkManager. **/ g_object_class_install_property (object_class, PROP_NEVER_DEFAULT, @@ -1245,11 +1247,11 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) * NMSettingIP6Config:may-fail: * * If %TRUE, allow overall network configuration to proceed even if IPv6 - * configuration times out. Note that at least one IP configuration - * must succeed or overall network configuration will still fail. For - * example, in IPv4-only networks, setting this property to %TRUE allows - * the overall network configuration to succeed if IPv6 configuration fails - * but IPv4 configuration completes successfully. + * configuration times out. Note that at least one IP configuration must + * succeed or overall network configuration will still fail. For example, + * in IPv4-only networks, setting this property to %TRUE allows the overall + * network configuration to succeed if IPv6 configuration fails but IPv4 + * configuration completes successfully. **/ g_object_class_install_property (object_class, PROP_MAY_FAIL, @@ -1269,13 +1271,13 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:ip6-privacy: * - * Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. - * If enabled, it makes the kernel generate a temporary IPv6 address - * in addition to the public one generated from MAC address via - * modified EUI-64. This enhances privacy, but could cause problems - * in some applications, on the other hand. The permitted values - * are: 0: disabled, 1: enabled (prefer public address), - * 2: enabled (prefer temporary addresses). + * Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If + * enabled, it makes the kernel generate a temporary IPv6 address in + * addition to the public one generated from MAC address via modified + * EUI-64. This enhances privacy, but could cause problems in some + * applications, on the other hand. The permitted values are: 0: disabled, + * 1: enabled (prefer public address), 2: enabled (prefer temporary + * addresses). **/ g_object_class_install_property (object_class, PROP_IP6_PRIVACY, diff --git a/libnm-util/nm-setting-olpc-mesh.c b/libnm-util/nm-setting-olpc-mesh.c index 3bff35da92..d344fa0432 100644 --- a/libnm-util/nm-setting-olpc-mesh.c +++ b/libnm-util/nm-setting-olpc-mesh.c @@ -265,9 +265,9 @@ nm_setting_olpc_mesh_class_init (NMSettingOlpcMeshClass *setting_class) /** * NMSettingOlpcMesh:dhcp-anycast-address: * - * Anycast DHCP address used when requesting an IP address via DHCP. The - * specific anycast address used determines which DHCP server class answers - * the request. + * Anycast DHCP MAC address used when requesting an IP address via DHCP. + * The specific anycast address used determines which DHCP server class + * answers the request. **/ g_object_class_install_property (object_class, PROP_DHCP_ANYCAST_ADDRESS, diff --git a/libnm-util/nm-setting-ppp.c b/libnm-util/nm-setting-ppp.c index 4a5a14e6f8..237af9c89d 100644 --- a/libnm-util/nm-setting-ppp.c +++ b/libnm-util/nm-setting-ppp.c @@ -567,8 +567,8 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) * NMSettingPPP:noauth: * * If %TRUE, do not require the other side (usually the PPP server) to - * authenticate itself to the client. If %FALSE, require authentication from - * the remote side. In almost all cases, this should be %TRUE. + * authenticate itself to the client. If %FALSE, require authentication + * from the remote side. In almost all cases, this should be %TRUE. **/ g_object_class_install_property (object_class, PROP_NOAUTH, @@ -662,7 +662,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) /** * NMSettingPPP:nodeflate: * - * If %TRUE, 'deflate' compression will not be requested. + * If %TRUE, "deflate" compression will not be requested. **/ g_object_class_install_property (object_class, PROP_NODEFLATE, @@ -709,7 +709,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) * NMSettingPPP:require-mppe-128: * * If %TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be - * required for the PPP session, and the 'require-mppe' property must also + * required for the PPP session, and the "require-mppe" property must also * be set to %TRUE. If 128-bit MPPE is not available the session will fail. **/ g_object_class_install_property @@ -743,8 +743,8 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) * NMSettingPPP:crtscts: * * If %TRUE, specify that pppd should set the serial port to use hardware - * flow control with RTS and CTS signals. This value should normally be - * set to %FALSE. + * flow control with RTS and CTS signals. This value should normally be set + * to %FALSE. **/ g_object_class_install_property (object_class, PROP_CRTSCTS, @@ -811,7 +811,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) * * If non-zero, instruct pppd to presume the connection to the peer has * failed if the specified number of LCP echo-requests go unanswered by the - * peer. The 'lcp-echo-interval' property must also be set to a non-zero + * peer. The "lcp-echo-interval" property must also be set to a non-zero * value if this property is used. **/ g_object_class_install_property diff --git a/libnm-util/nm-setting-pppoe.c b/libnm-util/nm-setting-pppoe.c index 2ea29a6e6d..fdae691b28 100644 --- a/libnm-util/nm-setting-pppoe.c +++ b/libnm-util/nm-setting-pppoe.c @@ -339,7 +339,7 @@ nm_setting_pppoe_class_init (NMSettingPPPOEClass *setting_class) /** * NMSettingPPPOE:password-flags: * - * Flags indicating how to handle #NMSettingPPPOE:password:. + * Flags indicating how to handle the #NMSettingPPPOE:password property. **/ g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_PPPOE_PASSWORD_FLAGS, diff --git a/libnm-util/nm-setting-serial.c b/libnm-util/nm-setting-serial.c index 2cb80c368e..70152bb3ce 100644 --- a/libnm-util/nm-setting-serial.c +++ b/libnm-util/nm-setting-serial.c @@ -255,8 +255,8 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class) /** * NMSettingSerial:baud: * - * Speed to use for communication over the serial port. Note that this value - * usually has no effect for mobile broadband modems as they generally + * Speed to use for communication over the serial port. Note that this + * value usually has no effect for mobile broadband modems as they generally * ignore speed settings and use the highest available speed. **/ g_object_class_install_property @@ -273,7 +273,7 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class) /** * NMSettingSerial:bits: * - * Byte-width of the serial communication. + * Byte-width of the serial communication. The 8 in "8n1" for example. **/ g_object_class_install_property (object_class, PROP_BITS, @@ -303,7 +303,7 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class) * NMSettingSerial:stopbits: * * Number of stop bits for communication on the serial port. Either 1 or 2. - * The 1 in '8n1' for example. + * The 1 in "8n1" for example. **/ g_object_class_install_property (object_class, PROP_STOPBITS, diff --git a/libnm-util/nm-setting-team-port.c b/libnm-util/nm-setting-team-port.c index c041927507..c0b7748bd2 100644 --- a/libnm-util/nm-setting-team-port.c +++ b/libnm-util/nm-setting-team-port.c @@ -169,12 +169,10 @@ nm_setting_team_port_class_init (NMSettingTeamPortClass *setting_class) /** * NMSettingTeamPort:config: * - * The config of team port - * JSON configuration for the team port. - * The property should contain raw JSON configuration data - * suitable for teamd, because the value is passed directly to - * teamd. If not specified, the default configuration is used. - * See man teamd.conf for the format details. + * The JSON configuration for the team port. The property should contain raw + * JSON configuration data suitable for teamd, because the value is passed + * directly to teamd. If not specified, the default configuration is + * used. See man teamd.conf for the format details. **/ g_object_class_install_property (object_class, PROP_CONFIG, diff --git a/libnm-util/nm-setting-team.c b/libnm-util/nm-setting-team.c index 80885b22da..af9da62c03 100644 --- a/libnm-util/nm-setting-team.c +++ b/libnm-util/nm-setting-team.c @@ -251,11 +251,10 @@ nm_setting_team_class_init (NMSettingTeamClass *setting_class) /** * NMSettingTeam:config: * - * JSON configuration for the team network interface. - * The property should contain raw JSON configuration data - * suitable for teamd, because the value is passed directly to - * teamd. If not specified, the default configuration is used. - * See man teamd.conf for the format details. + * The JSON configuration for the team network interface. The property + * should contain raw JSON configuration data suitable for teamd, because + * the value is passed directly to teamd. If not specified, the default + * configuration is used. See man teamd.conf for the format details. **/ g_object_class_install_property (object_class, PROP_CONFIG, diff --git a/libnm-util/nm-setting-vlan.c b/libnm-util/nm-setting-vlan.c index 49c724d8a7..ef91b5f12f 100644 --- a/libnm-util/nm-setting-vlan.c +++ b/libnm-util/nm-setting-vlan.c @@ -752,9 +752,9 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) * * If given, specifies the kernel name of the VLAN interface. If not given, * a default name will be constructed from the interface described by the - * parent interface and the #NMSettingVlan:id , ex 'eth2.1'. The parent - * interface may be given by the #NMSettingVlan:parent property or by the - * #NMSettingWired:mac-address property of an #NMSettingWired. + * parent interface and the #NMSettingVlan:id property, eg "eth2.1". The + * parent interface may be given by the #NMSettingVlan:parent property or by + * the #NMSettingWired:mac-address property of an #NMSettingWired setting. **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, @@ -775,8 +775,8 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) * * If given, specifies the parent interface name or parent connection UUID * from which this VLAN interface should be created. If this property is - * not specified, the connection must contain a #NMSettingWired:mac-address - * in an #NMSettingWired setting. + * not specified, the connection must contain an #NMSettingWired setting + * with a #NMSettingWired:mac-address property. **/ g_object_class_install_property (object_class, PROP_PARENT, @@ -793,8 +793,8 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) /** * NMSettingVlan:id: * - * The VLAN identifier the interface created by this connection should be - * assigned. + * The VLAN identifier that the interface created by this connection should + * be assigned. **/ g_object_class_install_property (object_class, PROP_ID, @@ -808,8 +808,11 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) /** * NMSettingVlan:flags: * - * One or more of #NMVlanFlags which control the behavior and features of - * the VLAN interface. + * One or more flags which control the behavior and features of the VLAN + * interface. Flags include %NM_VLAN_FLAG_REORDER_HEADERS (reordering of + * output packet headers), %NM_VLAN_FLAG_GVRP (use of the GVRP protocol), + * and %NM_VLAN_FLAG_LOOSE_BINDING (loose binding of the interface to its + * master device's operating state). **/ g_object_class_install_property (object_class, PROP_FLAGS, @@ -828,8 +831,8 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) * NMSettingVlan:ingress-priority-map: * * For incoming packets, a list of mappings from 802.1p priorities to Linux - * SKB priorities. The mapping is given in the format 'from:to' where both - * 'from' and 'to' are unsigned integers, ie '7:3'. + * SKB priorities. The mapping is given in the format "from:to" where both + * "from" and "to" are unsigned integers, ie "7:3". **/ g_object_class_install_property (object_class, PROP_INGRESS_PRIORITY_MAP, @@ -847,8 +850,8 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) * NMSettingVlan:egress-priority-map: * * For outgoing packets, a list of mappings from Linux SKB priorities to - * 802.1p priorities. The mapping is given in the format 'from:to' - * where both 'from' and 'to' are unsigned integers, ie '7:3'. + * 802.1p priorities. The mapping is given in the format "from:to" where + * both "from" and "to" are unsigned integers, ie "7:3". **/ g_object_class_install_property (object_class, PROP_EGRESS_PRIORITY_MAP, diff --git a/libnm-util/nm-setting-vpn.c b/libnm-util/nm-setting-vpn.c index b5cffc14b6..4b479b8f3f 100644 --- a/libnm-util/nm-setting-vpn.c +++ b/libnm-util/nm-setting-vpn.c @@ -816,8 +816,8 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class) /** * NMSettingVPN:service-type: * - * D-Bus service name of the VPN plugin that this setting uses to connect - * to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc + * D-Bus service name of the VPN plugin that this setting uses to connect to + * its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc * plugin. **/ g_object_class_install_property @@ -835,8 +835,8 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class) * NMSettingVPN:user-name: * * If the VPN connection requires a user name for authentication, that name - * should be provided here. If the connection is available to more than - * one user, and the VPN requires each user to supply a different name, then + * should be provided here. If the connection is available to more than one + * user, and the VPN requires each user to supply a different name, then * leave this property empty. If this property is empty, NetworkManager * will automatically supply the username of the user which requested the * VPN connection. @@ -859,8 +859,8 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class) /** * NMSettingVPN:data: * - * Dictionary of key/value pairs of VPN plugin specific data. Both keys - * and values must be strings. + * Dictionary of key/value pairs of VPN plugin specific data. Both keys and + * values must be strings. **/ g_object_class_install_property (object_class, PROP_DATA, diff --git a/libnm-util/nm-setting-wimax.c b/libnm-util/nm-setting-wimax.c index 60eb1c5a82..8bf16b3de1 100644 --- a/libnm-util/nm-setting-wimax.c +++ b/libnm-util/nm-setting-wimax.c @@ -251,9 +251,9 @@ nm_setting_wimax_class_init (NMSettingWimaxClass *setting_class) /** * NMSettingWimax:mac-address: * - * If specified, this connection will only apply to the WiMAX device - * whose MAC address matches. This property does not change the MAC address - * of the device (known as MAC spoofing). + * If specified, this connection will only apply to the WiMAX device whose + * MAC address matches. This property does not change the MAC address of the + * device (known as MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, diff --git a/libnm-util/nm-setting-wired.c b/libnm-util/nm-setting-wired.c index a57a07e855..a956a52f07 100644 --- a/libnm-util/nm-setting-wired.c +++ b/libnm-util/nm-setting-wired.c @@ -871,8 +871,8 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:port: * * Specific port type to use if multiple the device supports multiple - * attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit - * Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. + * attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit + * Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface. * If the device supports only one port type, this setting is ignored. **/ g_object_class_install_property @@ -891,8 +891,8 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) /** * NMSettingWired:speed: * - * If non-zero, request that the device use only the specified speed. - * In Mbit/s, ie 100 == 100Mbit/s. + * If non-zero, request that the device use only the specified speed. In + * Mbit/s, ie 100 == 100Mbit/s. **/ g_object_class_install_property (object_class, PROP_SPEED, @@ -907,7 +907,7 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:duplex: * * If specified, request that the device only use the specified duplex mode. - * Either 'half' or 'full'. + * Either "half" or "full". **/ g_object_class_install_property (object_class, PROP_DUPLEX, @@ -921,9 +921,9 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) /** * NMSettingWired:auto-negotiate: * - * If %TRUE, allow auto-negotiation of port speed and duplex mode. If %FALSE, - * do not allow auto-negotiation, in which case the 'speed' and 'duplex' - * properties should be set. + * If %TRUE, allow auto-negotiation of port speed and duplex mode. If + * %FALSE, do not allow auto-negotiation, in which case the "speed" and + * "duplex" properties should be set. **/ g_object_class_install_property (object_class, PROP_AUTO_NEGOTIATE, @@ -940,8 +940,8 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:mac-address: * * If specified, this connection will only apply to the Ethernet device - * whose permanent MAC address matches. This property does not change the MAC address - * of the device (i.e. MAC spoofing). + * whose permanent MAC address matches. This property does not change the + * MAC address of the device (i.e. MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, @@ -974,8 +974,8 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:mac-address-blacklist: * * If specified, this connection will never apply to the Ethernet device - * whose permanent MAC address matches an address in the list. Each - * MAC address is in the standard hex-digits-and-colons notation + * whose permanent MAC address matches an address in the list. Each MAC + * address is in the standard hex-digits-and-colons notation * (00:11:22:33:44:55). **/ g_object_class_install_property @@ -1009,11 +1009,12 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:s390-subchannels: * * Identifies specific subchannels that this network device uses for - * communcation with z/VM or s390 host. Like #NMSettingWired:mac-address - * for non-z/VM devices, this property can be used to ensure this connection - * only applies to the network device that uses these subchannels. The - * list should contain exactly 3 strings, and each string may only be - * composed of hexadecimal characters and the period (.) character. + * communication with z/VM or s390 host. Like the + * #NMSettingWired:mac-address property for non-z/VM devices, this property + * can be used to ensure this connection only applies to the network device + * that uses these subchannels. The list should contain exactly 3 strings, + * and each string may only be composed of hexadecimal characters and the + * period (.) character. **/ g_object_class_install_property (object_class, PROP_S390_SUBCHANNELS, @@ -1034,7 +1035,7 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) /** * NMSettingWired:s390-nettype: * - * s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing + * s390 network device type; one of "qeth", "lcs", or "ctc", representing * the different types of virtual network devices available on s390 systems. **/ g_object_class_install_property @@ -1051,8 +1052,8 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:s390-options: * * Dictionary of key/value pairs of s390-specific device options. Both keys - * and values must be strings. Allowed keys include 'portno', 'layer2', - * 'portname', 'protocol', among others. Key names must contain only + * and values must be strings. Allowed keys include "portno", "layer2", + * "portname", "protocol", among others. Key names must contain only * alphanumeric characters (ie, [a-zA-Z0-9]). **/ g_object_class_install_property diff --git a/libnm-util/nm-setting-wireless-security.c b/libnm-util/nm-setting-wireless-security.c index 2191ef4246..40c561813f 100644 --- a/libnm-util/nm-setting-wireless-security.c +++ b/libnm-util/nm-setting-wireless-security.c @@ -1348,9 +1348,9 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:key-mgmt: * - * Key management used for the connection. One of 'none' (WEP), 'ieee8021x' - * (Dynamic WEP), 'wpa-none' (Ad-Hoc WPA-PSK), 'wpa-psk' (infrastructure - * WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for + * Key management used for the connection. One of "none" (WEP), "ieee8021x" + * (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure + * WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for * any Wi-Fi connection that uses security. **/ g_object_class_install_property @@ -1368,7 +1368,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:wep-tx-keyidx: * - * When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key + * When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key * index is used by the AP, put that WEP key index here. Valid values are 0 * (default key) through 3. Note that some consumer access points (like the * Linksys WRT54G) number the keys 1 - 4. @@ -1388,11 +1388,11 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:auth-alg: * - * When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the - * 802.11 authentication algorithm required by the AP here. One of 'open' - * for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. - * When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') - * the 'leap-username' and 'leap-password' properties must be specified. + * When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the + * 802.11 authentication algorithm required by the AP here. One of "open" + * for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When + * using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the + * "leap-username" and "leap-password" properties must be specified. **/ g_object_class_install_property (object_class, PROP_AUTH_ALG, @@ -1412,7 +1412,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:proto: * * List of strings specifying the allowed WPA protocol versions to use. - * Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If + * Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If * not specified, both WPA and RSN connections are allowed. **/ g_object_class_install_property @@ -1431,9 +1431,9 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:pairwise: * * A list of pairwise encryption algorithms which prevents connections to - * Wi-Fi networks that do not utilize one of the algorithms in the list. For - * maximum compatibility leave this property empty. Each list element may - * be one of 'tkip' or 'ccmp'. + * Wi-Fi networks that do not utilize one of the algorithms in the list. + * For maximum compatibility leave this property empty. Each list element + * may be one of "tkip" or "ccmp". **/ g_object_class_install_property (object_class, PROP_PAIRWISE, @@ -1454,7 +1454,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * A list of group/broadcast encryption algorithms which prevents * connections to Wi-Fi networks that do not utilize one of the algorithms * in the list. For maximum compatibility leave this property empty. Each - * list element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'. + * list element may be one of "wep40", "wep104", "tkip", or "ccmp". **/ g_object_class_install_property (object_class, PROP_GROUP, @@ -1473,7 +1473,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:leap-username: * * The login username for legacy LEAP connections (ie, key-mgmt = - * 'ieee8021x' and auth-alg = 'leap'). + * "ieee8021x" and auth-alg = "leap"). **/ g_object_class_install_property (object_class, PROP_LEAP_USERNAME, @@ -1488,7 +1488,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:wep-key0: * * Index 0 WEP key. This is the WEP key used in most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY0, @@ -1504,7 +1504,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:wep-key1: * * Index 1 WEP key. This WEP index is not used by most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY1, @@ -1520,7 +1520,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:wep-key2: * * Index 2 WEP key. This WEP index is not used by most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY2, @@ -1536,7 +1536,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:wep-key3: * * Index 3 WEP key. This WEP index is not used by most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY3, @@ -1551,7 +1551,9 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:wep-key-flags: * - * Flags indicating how to handle #NMSettingWirelessSecurity WEP keys. + * Flags indicating how to handle the #NMSettingWirelessSecurity:wep-key0, + * #NMSettingWirelessSecurity:wep-key1, #NMSettingWirelessSecurity:wep-key2, + * and #NMSettingWirelessSecurity:wep-key3 properties. **/ g_object_class_install_property (object_class, PROP_WEP_KEY_FLAGS, g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS, @@ -1568,8 +1570,8 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * Pre-Shared-Key for WPA networks. If the key is 64-characters long, it * must contain only hexadecimal characters and is interpreted as a * hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII - * characters (as specified in the 802.11i standard) and is interpreted as - * a WPA passphrase, and is hashed to derive the actual WPA-PSK used when + * characters (as specified in the 802.11i standard) and is interpreted as a + * WPA passphrase, and is hashed to derive the actual WPA-PSK used when * connecting to the Wi-Fi network. **/ g_object_class_install_property @@ -1590,7 +1592,8 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:psk-flags: * - * Flags indicating how to handle #NMSettingWirelessSecurity:psk + * Flags indicating how to handle the #NMSettingWirelessSecurity:psk + * property. **/ g_object_class_install_property (object_class, PROP_PSK_FLAGS, g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS, @@ -1605,7 +1608,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * NMSettingWirelessSecurity:leap-password: * * The login password for legacy LEAP connections (ie, key-mgmt = - * 'ieee8021x' and auth-alg = 'leap'). + * "ieee8021x" and auth-alg = "leap"). **/ g_object_class_install_property (object_class, PROP_LEAP_PASSWORD, @@ -1619,7 +1622,8 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:leap-password-flags: * - * Flags indicating how to handle #NMSettingWirelessSecurity:leap-password. + * Flags indicating how to handle the + * #NMSettingWirelessSecurity:leap-password property. **/ g_object_class_install_property (object_class, PROP_LEAP_PASSWORD_FLAGS, g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS, @@ -1633,12 +1637,12 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:wep-key-type: * - * Controls the interpretation of WEP keys. Allowed values are those given - * by #NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be - * either 10 or 26 characters in length. If set to 1 and the keys are - * ASCII keys, they must be either 5 or 13 characters in length. If set to - * 2, the passphrase is hashed using the de-facto MD5 method to derive the - * actual WEP key. + * Controls the interpretation of WEP keys. Allowed values are + * %NM_WEP_KEY_TYPE_KEY, in which case the key is either a 10- or + * 26-character hexadecimal string, or a 5- or 13-character ASCII password; + * or %NM_WEP_KEY_TYPE_PASSPHRASE, in which case the passphrase is provided + * as a string and will be hashed using the de-facto MD5 method to derive + * the actual WEP key. **/ g_object_class_install_property (object_class, PROP_WEP_KEY_TYPE, diff --git a/libnm-util/nm-setting-wireless.c b/libnm-util/nm-setting-wireless.c index e47ebcb0b1..ca53d6f95c 100644 --- a/libnm-util/nm-setting-wireless.c +++ b/libnm-util/nm-setting-wireless.c @@ -1033,7 +1033,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:ssid: * - * SSID of the Wi-Fi network. + * SSID of the Wi-Fi network. Must be specified. **/ g_object_class_install_property (object_class, PROP_SSID, @@ -1046,7 +1046,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:mode: * - * Wi-Fi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, + * Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, * infrastructure is assumed. **/ g_object_class_install_property @@ -1061,9 +1061,9 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:band: * - * 802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or - * 'bg' for 2.4GHz 802.11. This will lock associations to the Wi-Fi network - * to the specific band, i.e. if 'a' is specified, the device will not + * 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or + * "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network + * to the specific band, i.e. if "a" is specified, the device will not * associate with the same network in the 2.4GHz band even if the network's * settings are compatible. This setting depends on specific driver * capability and may not work with all drivers. @@ -1089,7 +1089,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * Wireless channel to use for the Wi-Fi connection. The device will only * join (or create for Ad-Hoc networks) a Wi-Fi network on the specified * channel. Because channel numbers overlap between bands, this property - * also requires the 'band' property to be set. + * also requires the "band" property to be set. **/ g_object_class_install_property (object_class, PROP_CHANNEL, @@ -1165,9 +1165,9 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:mac-address: * - * If specified, this connection will only apply to the Wi-Fi device - * whose permanent MAC address matches. This property does not change the MAC address - * of the device (i.e. MAC spoofing). + * If specified, this connection will only apply to the Wi-Fi device whose + * permanent MAC address matches. This property does not change the MAC + * address of the device (i.e. MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, @@ -1183,8 +1183,8 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:cloned-mac-address: * - * If specified, request that the Wi-Fi device use this MAC address instead of its - * permanent MAC address. This is known as MAC cloning or spoofing. + * If specified, request that the Wi-Fi device use this MAC address instead + * of its permanent MAC address. This is known as MAC cloning or spoofing. **/ g_object_class_install_property (object_class, PROP_CLONED_MAC_ADDRESS, @@ -1201,7 +1201,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * * A list of permanent MAC addresses of Wi-Fi devices to which this * connection should never apply. Each MAC address should be given in the - * standard hex-digits-and-colons notation (eg '00:11:22:33:44:55'). + * standard hex-digits-and-colons notation (eg "00:11:22:33:44:55"). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS_BLACKLIST, @@ -1219,10 +1219,11 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * NMSettingWireless:seen-bssids: * * A list of BSSIDs (each BSSID formatted as a MAC address like - * '00:11:22:33:44:55') that have been detected as part of the Wi-Fi network. - * NetworkManager internally tracks previously seen BSSIDs. The property is only - * meant for reading and reflects the BSSID list of NetworkManager. The changes you - * make to this property will not be preserved. + * "00:11:22:33:44:55") that have been detected as part of the Wi-Fi + * network. NetworkManager internally tracks previously seen BSSIDs. The + * property is only meant for reading and reflects the BSSID list of + * NetworkManager. The changes you make to this property will not be + * preserved. **/ g_object_class_install_property (object_class, PROP_SEEN_BSSIDS, @@ -1259,11 +1260,13 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * NMSettingWireless:security: * * If the wireless connection has any security restrictions, like 802.1x, - * WEP, or WPA, set this property to '802-11-wireless-security' and ensure - * the connection contains a valid 802-11-wireless-security setting. + * WEP, or WPA, set this property to + * %NM_SETTING_WIRELESS_SECURITY_SETTING_NAME and ensure the connection + * contains a valid #NMSettingWirelessSecurity setting. * - * Deprecated: 0.9.10: No longer used. Security rescrictions are recognized by - * the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection. + * Deprecated: 0.9.10: No longer used. Security restrictions are recognized + * by the presence of a #NMSettingWirelessSecurity setting in the + * connection. **/ g_object_class_install_property (object_class, PROP_SEC, @@ -1280,9 +1283,9 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:hidden: * - * If %TRUE, indicates this network is a non-broadcasting network that - * hides its SSID. In this case various workarounds may take place, such - * as probe-scanning the SSID for more reliable network discovery. However, + * If %TRUE, indicates this network is a non-broadcasting network that hides + * its SSID. In this case various workarounds may take place, such as + * probe-scanning the SSID for more reliable network discovery. However, * these workarounds expose inherent insecurities with hidden SSID networks, * and thus hidden SSID networks should be used with caution. **/ diff --git a/libnm-util/nm-setting.c b/libnm-util/nm-setting.c index 63629c05a5..0e8a06c4d8 100644 --- a/libnm-util/nm-setting.c +++ b/libnm-util/nm-setting.c @@ -1344,7 +1344,7 @@ nm_setting_class_init (NMSettingClass *setting_class) * * 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'. + * example "ppp" or "wireless" or "wired". **/ g_object_class_install_property (object_class, PROP_NAME, |