From ace5cd01385f2cecc4d4987958f07dfa292cbb2f Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 6 Aug 2012 18:41:15 -0500 Subject: [PATCH] docs: document OLPC Mesh setting errors --- libnm-util/nm-setting-olpc-mesh.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/libnm-util/nm-setting-olpc-mesh.h b/libnm-util/nm-setting-olpc-mesh.h index a6b6037aeb..59c03b485e 100644 --- a/libnm-util/nm-setting-olpc-mesh.h +++ b/libnm-util/nm-setting-olpc-mesh.h @@ -41,8 +41,14 @@ G_BEGIN_DECLS #define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh" -typedef enum -{ +/** + * NMSettingOlpcMeshError: + * @NM_SETTING_OLPC_MESH_ERROR_UNKNOWN: unknown or unclassified error + * @NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY: the property was invalid + * @NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY: the property was missing and is + * required + */ +typedef enum { NM_SETTING_OLPC_MESH_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/ NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY /*< nick=MissingProperty >*/