diff options
author | Dan Williams <dcbw@redhat.com> | 2009-11-11 14:07:25 -0800 |
---|---|---|
committer | Dan Williams <dcbw@redhat.com> | 2009-11-11 14:21:03 -0800 |
commit | 050dbd6d7ef21248982c825b8fd936274028fa33 (patch) | |
tree | 46d536a17b07f8adf7a231eccf92329e6777b5d4 /libnm-util | |
parent | 03b2d7cfc5d441b6e3efb8597f6617500828393b (diff) |
doc: document vpn setting properties
Diffstat (limited to 'libnm-util')
-rw-r--r-- | libnm-util/nm-setting-vpn.c | 47 |
1 files changed, 43 insertions, 4 deletions
diff --git a/libnm-util/nm-setting-vpn.c b/libnm-util/nm-setting-vpn.c index 133c8de683..8523dc1d5f 100644 --- a/libnm-util/nm-setting-vpn.c +++ b/libnm-util/nm-setting-vpn.c @@ -374,35 +374,74 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class) parent_class->update_one_secret = update_one_secret; /* Properties */ + /** + * 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 + * plugin. + **/ g_object_class_install_property (object_class, PROP_SERVICE_TYPE, g_param_spec_string (NM_SETTING_VPN_SERVICE_TYPE, "Service type", - "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 " + "plugin.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); + /** + * NMSettinVPN:user-name: + * + * User name of the currently logged in user for connections provided by the + * user settings service. This name is provided to the VPN plugin to use in + * lieu of a custom username provided by that VPN plugins specific + * configuration. The VPN plugin itself decides which user name to use. + **/ g_object_class_install_property (object_class, PROP_USER_NAME, g_param_spec_string (NM_SETTING_VPN_USER_NAME, "User name", - "User name", + "User name of the currently logged in user for " + "connections provided by the user settings service. " + "This name is provided to the VPN plugin to use in " + "lieu of a custom username provided by that VPN " + "plugins specific configuration. The VPN plugin " + "itself decides which user name to use.", NULL, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); + /** + * NMSettingVPN:data: + * + * 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, _nm_param_spec_specialized (NM_SETTING_VPN_DATA, "Data", - "VPN Service specific data", + "Dictionary of key/value pairs of VPN plugin " + "specific data. Both keys and values must be " + "strings.", DBUS_TYPE_G_MAP_OF_STRING, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE)); + /** + * NMSettingVPN:secrets: + * + * Dictionary of key/value pairs of VPN plugin specific secrets like + * passwords or private keys. Both keys and values must be strings. + **/ g_object_class_install_property (object_class, PROP_SECRETS, _nm_param_spec_specialized (NM_SETTING_VPN_SECRETS, "Secrets", - "VPN Service specific secrets", + "Dictionary of key/value pairs of VPN plugin " + "specific secrets like passwords or private keys." + " Both keys and values must be strings.", DBUS_TYPE_G_MAP_OF_STRING, G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE | NM_SETTING_PARAM_SECRET)); } |