From 55f55781a800226a15e8755d514623a7433c388c Mon Sep 17 00:00:00 2001
From: Dan Williams <dcbw@redhat.com>
Date: Tue, 5 Jul 2011 18:17:08 -0500
Subject: docs: update Serial setting documentation

---
 libnm-util/nm-setting-serial.h | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'libnm-util/nm-setting-serial.h')

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,
-- 
cgit v1.2.1