diff options
| author | Jiří Klimeš <jklimes@redhat.com> | 2014-07-04 09:31:19 +0200 |
|---|---|---|
| committer | Jiří Klimeš <jklimes@redhat.com> | 2014-08-29 13:59:54 +0200 |
| commit | 71e07344ab3318a599275c69131fd0f0a5ee937a (patch) | |
| tree | 4d7de88ea9a2d33e31349c7a5c273a5fd4e01c19 /libnm-util/nm-setting-wireless.c | |
| parent | f27fac5109ca28173b4a3a9ff225df7757f4cd57 (diff) | |
| download | NetworkManager-71e07344ab3318a599275c69131fd0f0a5ee937a.tar.gz | |
libnm-util: add keyfile specific description for properties
as comments in libnm-util/nm-setting-*.c files
The comments are parsed by generate-plugin-docs.pl script.
Diffstat (limited to 'libnm-util/nm-setting-wireless.c')
| -rw-r--r-- | libnm-util/nm-setting-wireless.c | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/libnm-util/nm-setting-wireless.c b/libnm-util/nm-setting-wireless.c index 24fae397b3..bf2f0a1767 100644 --- a/libnm-util/nm-setting-wireless.c +++ b/libnm-util/nm-setting-wireless.c @@ -1032,6 +1032,14 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * * SSID of the Wi-Fi network. Must be specified. **/ + /* plugins docs + * ---keyfile--- + * property: ssid + * format: string (or decimal-byte list - obsolete) + * description: SSID of Wi-Fi network. + * example: ssid=Quick Net + * ---end--- + */ g_object_class_install_property (object_class, PROP_SSID, _nm_param_spec_specialized (NM_SETTING_WIRELESS_SSID, "", "", @@ -1140,6 +1148,15 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * permanent MAC address matches. This property does not change the MAC * address of the device (i.e. MAC spoofing). **/ + /* plugins docs + * ---keyfile--- + * property: mac-address + * format: ususal hex-digits-and-colons notation + * description: MAC address in traditional hex-digits-and-colons notation + * (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) + * (e.g. 0;34;104;18;121;162). + * ---end--- + */ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS, "", "", @@ -1153,6 +1170,15 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * 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. **/ + /* plugins docs + * ---keyfile--- + * property: cloned-mac-address + * format: ususal hex-digits-and-colons notation + * description: Cloned MAC address in traditional hex-digits-and-colons notation + * (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) + * (e.g. 0;34;104;18;121;178). + * ---end--- + */ g_object_class_install_property (object_class, PROP_CLONED_MAC_ADDRESS, _nm_param_spec_specialized (NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS, "", "", @@ -1167,6 +1193,14 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) * 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"). **/ + /* plugins docs + * ---keyfile--- + * property: mac-address-blacklist + * format: list of MACs (separated with semicolons) + * description: MAC address blacklist. + * example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 + * ---end--- + */ g_object_class_install_property (object_class, PROP_MAC_ADDRESS_BLACKLIST, _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST, "", "", |