Diff: WiflyInterface.h

Revision:

8:9a3cd07ed7e8

Parent:

7:a92dbed32890

diff -r a92dbed32890 -r 9a3cd07ed7e8 WiflyInterface.h
--- a/WiflyInterface.h	Thu Aug 23 12:59:19 2012 +0000
+++ b/WiflyInterface.h	Thu Aug 23 14:08:08 2012 +0000
@@ -28,6 +28,17 @@
 class WiflyInterface: public Wifly {
 public:
 
+    /**
+    * Constructor
+    *
+    * \param tx mbed pin to use for tx line of Serial interface
+    * \param rx mbed pin to use for rx line of Serial interface
+    * \param reset reset pin of the wifi module ()
+    * \param tcp_status connection status pin of the wifi module (GPIO 6)
+    * \param ssid ssid of the network
+    * \param phrase WEP or WPA key
+    * \param sec Security type (NONE, WEP_128 or WPA)
+    */
   WiflyInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec = NONE);
 
   /** Initialize the interface with DHCP.