summaryrefslogtreecommitdiff
path: root/libnm-util/nm-setting-serial.h
diff options
context:
space:
mode:
authorDan Williams <dcbw@redhat.com>2011-07-05 18:17:08 -0500
committerDan Williams <dcbw@redhat.com>2011-07-05 18:17:08 -0500
commit55f55781a800226a15e8755d514623a7433c388c (patch)
tree4d4cf1323e40d984cc1452f32db9016643762c01 /libnm-util/nm-setting-serial.h
parent2de340ab7a09b73b40be9295dfb7d9555af1bbb6 (diff)
downloadNetworkManager-55f55781a800226a15e8755d514623a7433c388c.tar.gz
docs: update Serial setting documentation
Diffstat (limited to 'libnm-util/nm-setting-serial.h')
-rw-r--r--libnm-util/nm-setting-serial.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/libnm-util/nm-setting-serial.h b/libnm-util/nm-setting-serial.h
index d39e5a7943..9562950c95 100644
--- a/libnm-util/nm-setting-serial.h
+++ b/libnm-util/nm-setting-serial.h
@@ -39,8 +39,16 @@ G_BEGIN_DECLS
#define NM_SETTING_SERIAL_SETTING_NAME "serial"
-typedef enum
-{
+/**
+ * NMSettingSerialError:
+ * @NM_SETTING_SERIAL_ERROR_UNKNOWN: unknown or unclassified error
+ * @NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY: the property was invalid
+ * @NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY: the property was missing and is
+ * required
+ * @NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING: one of the properties of the
+ * setting requires the connection to contain an #NMSettingPPP setting
+ */
+typedef enum {
NM_SETTING_SERIAL_ERROR_UNKNOWN = 0,
NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY,
NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY,