ban4jp - / XBeeWiFi_common

EthernetNetIf Compatibility.

Dependents:   XBeeWiFi_SPI_example

Fork of NetServicesSource by Donatien Garnier

Diff: if/ppp/PPPNetIf.h

Revision:
6:b7dd7cde8ad2
Parent:
0:632c9925f013
Child:
7:534fa46ad8c5
--- a/if/ppp/PPPNetIf.h	Tue Jul 27 15:59:42 2010 +0000
+++ b/if/ppp/PPPNetIf.h	Wed Jul 28 10:18:21 2010 +0000
@@ -21,6 +21,10 @@
 THE SOFTWARE.
 */
 
+/** \file
+PPP Generic network interface header file
+*/
+
 //This is a NetServer-like backend for PPP, using lwIP
 
 #ifndef PPPNETIF_H
@@ -34,14 +38,15 @@
 #include "drv/gprs/GPRSModem.h"
 #include "if/lwip/LwipNetIf.h"
 
+///PPP connection error codes
 enum PPPErr
 {
   __PPP_MIN = -0xFFFF,
-  PPP_MODEM, //ATErr returned
-  PPP_NETWORK,
-  PPP_PROTOCOL,
-  PPP_CLOSED,
-  PPP_OK = 0
+  PPP_MODEM, ///<AT error returned
+  PPP_NETWORK, ///<Network is down
+  PPP_PROTOCOL, ///<PPP Protocol error
+  PPP_CLOSED, ///<Connection is closed
+  PPP_OK = 0 ///<Success
 };
 
 enum PPPStatus