docs: document the PPPoE setting
authorDan Williams <dcbw@redhat.com>
Tue, 19 Jul 2011 16:07:39 +0000 (11:07 -0500)
committerDan Williams <dcbw@redhat.com>
Tue, 19 Jul 2011 16:08:38 +0000 (11:08 -0500)
libnm-util/nm-setting-pppoe.c
libnm-util/nm-setting-pppoe.h

index 18dd798..249b767 100644 (file)
 #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: 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)
 {
index d163dec..aef6bd6 100644 (file)
@@ -39,8 +39,16 @@ G_BEGIN_DECLS
 
 #define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
 
-typedef enum
-{
+/**
+ * NMSettingPPPOEError:
+ * @NM_SETTING_PPPOE_ERROR_UNKNOWN: unknown or unclassified error
+ * @NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY: the property was invalid
+ * @NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY: the property was missing and is
+ * required
+ * @NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING: the connection
+ * did not contain a required PPP setting for PPP related options
+ */
+typedef enum {
        NM_SETTING_PPPOE_ERROR_UNKNOWN = 0,
        NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY,
        NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY,