From d208bbd4c42e6069cea3d845b21d282c6802d61c Mon Sep 17 00:00:00 2001
From: Dan Williams <dcbw@redhat.com>
Date: Thu, 17 Mar 2011 13:26:37 -0500
Subject: [PATCH] api: document NM_DEVICE_STATE_FAILED

---
 include/NetworkManager.h | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/include/NetworkManager.h b/include/NetworkManager.h
index d421aff3b6..f06e5c0e3e 100644
--- a/include/NetworkManager.h
+++ b/include/NetworkManager.h
@@ -249,9 +249,11 @@ typedef enum {
  *   activated
  * @NM_DEVICE_STATE_ACTIVATED: the device has a network connection, either local
  *   or global.
- * @NM_DEVICE_STATE_DEACTIVATING: the device's network connection is no longer
- *   valid and the device is tearing down resources used for the previous
- *   connection.
+ * @NM_DEVICE_STATE_DEACTIVATING: a disconnection from the current network
+ *   connection was requested, and the device is cleaning up resources used for
+ *   that connection.  The network connection may still be valid.
+ * @NM_DEVICE_STATE_FAILED: the device failed to connect to the requested
+ *   network and is cleaning up the connection request
  *
  **/
 typedef enum {