diff options
Diffstat (limited to 'libnm-util/nm-setting-pppoe.c')
| -rw-r--r-- | libnm-util/nm-setting-pppoe.c | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/libnm-util/nm-setting-pppoe.c b/libnm-util/nm-setting-pppoe.c index 18dd7983..4a9b8a22 100644 --- a/libnm-util/nm-setting-pppoe.c +++ b/libnm-util/nm-setting-pppoe.c @@ -28,6 +28,23 @@ #include "nm-setting-ppp.h" #include "nm-setting-private.h" +/** + * SECTION:nm-setting-pppoe + * @short_description: Describes PPPoE connection properties + * @include: nm-setting-pppoe.h + * + * The #NMSettingPPPOE object is a #NMSetting subclass that describes + * properties necessary for connection to networks that require PPPoE connections + * to provide IP transport, for example cable or DSL modems. + **/ + +/** + * nm_setting_pppoe_error_quark: + * + * Registers an error quark for #NMSettingPPPOE if necessary. + * + * Returns: the error quark used for #NMSettingPPPOE errors. + **/ GQuark nm_setting_pppoe_error_quark (void) { @@ -85,12 +102,25 @@ enum { LAST_PROP }; +/** + * nm_setting_pppoe_new: + * + * Creates a new #NMSettingPPPOE object with default values. + * + * Returns: (transfer full): the new empty #NMSettingPPPOE object + **/ NMSetting * nm_setting_pppoe_new (void) { return (NMSetting *) g_object_new (NM_TYPE_SETTING_PPPOE, NULL); } +/** + * nm_setting_pppoe_get_service: + * @setting: the #NMSettingPPPOE + * + * Returns: the #NMSettingPPPOE:service property of the setting + **/ const char * nm_setting_pppoe_get_service (NMSettingPPPOE *setting) { @@ -99,6 +129,12 @@ nm_setting_pppoe_get_service (NMSettingPPPOE *setting) return NM_SETTING_PPPOE_GET_PRIVATE (setting)->service; } +/** + * nm_setting_pppoe_get_service: + * @setting: the #NMSettingPPPOE + * + * Returns: the #NMSettingPPPOE:username property of the setting + **/ const char * nm_setting_pppoe_get_username (NMSettingPPPOE *setting) { @@ -107,6 +143,12 @@ nm_setting_pppoe_get_username (NMSettingPPPOE *setting) return NM_SETTING_PPPOE_GET_PRIVATE (setting)->username; } +/** + * nm_setting_pppoe_get_service: + * @setting: the #NMSettingPPPOE + * + * Returns: the #NMSettingPPPOE:password property of the setting + **/ const char * nm_setting_pppoe_get_password (NMSettingPPPOE *setting) { |