Revision 15:121f473dae3f, committed 2013-07-21

Comitter:

WiredHome

Date:

Sun Jul 21 16:15:00 2013 +0000

Parent:

14:473d73cb48ee

Child:

16:55b5c1f9b8ed

Commit message:

Updated the documentation so the methods appear and documented parameters that existed, but were not previously documented.

Changed in this revision

--- a/Wifly/Wifly.h	Sun Jul 21 15:55:28 2013 +0000
+++ b/Wifly/Wifly.h	Sun Jul 21 16:15:00 2013 +0000
@@ -43,11 +43,15 @@
     TCP = (1 << 1)
 };
 
+/** the Wifly object
+*
+* This object controls the Wifly module.
+*/
 class Wifly
 {
 
 public:
-    /*
+    /**
     * Constructor
     *
     * @param tx mbed pin to use for tx line of Serial interface
@@ -60,21 +64,21 @@
     */
     Wifly(  PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
 
-    /*
+    /**
     * Connect the wifi module to the ssid contained in the constructor.
     *
     * @return true if connected, false otherwise
     */
     bool join();
 
-    /*
+    /**
     * Disconnect the wifly module from the access point
     *
     * @ returns true if successful
     */
     bool disconnect();
 
-    /*
+    /**
     * Open a tcp connection with the specified host on the specified port
     *
     * @param host host (can be either an ip address or a name. If a name is provided, a dns request will be established)
@@ -84,7 +88,7 @@
     bool connect(const char * host, int port);
 
 
-    /*
+    /**
     * Set the protocol (UDP or TCP)
     *
     * @param p protocol
@@ -92,50 +96,50 @@
     */
     bool setProtocol(Protocol p);
 
-    /*
+    /**
     * Reset the wifi module
     */
     void reset();
     
-    /*
+    /**
     * Reboot the wifi module
     */
     bool reboot();
 
-    /*
+    /**
     * Check if characters are available
     *
     * @return number of available characters
     */
     int readable();
 
-    /*
+    /**
     * Check if characters are available
     *
     * @return number of available characters
     */
     int writeable();
 
-    /*
+    /**
     * Check if a tcp link is active
     *
     * @returns true if successful
     */
     bool is_connected();
 
-    /*
+    /**
     * Read a character
     *
     * @return the character read
     */
     char getc();
 
-    /*
+    /**
     * Flush the buffer
     */
     void flush();
 
-    /*
+    /**
     * Write a character
     *
     * @param the character which will be written
@@ -143,28 +147,28 @@
     int putc(char c);
 
 
-    /*
+    /**
     * To enter in command mode (we can configure the module)
     *
     * @return true if successful, false otherwise
     */
     bool cmdMode();
 
-    /*
+    /**
     * To exit the command mode
     *
     * @return true if successful, false otherwise
     */
     bool exit();
 
-    /*
+    /**
     * Close a tcp connection
     *
     * @ returns true if successful
     */
     bool close();
 
-    /*
+    /**
     * Send a string to the wifi module by serial port. This function desactivates the user interrupt handler when a character is received to analyze the response from the wifi module.
     * Useful to send a command to the module and wait a response.
     *
@@ -173,23 +177,25 @@
     * @param len string length
     * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
     * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
+    * @param timeout is the time in msec to wait for the acknowledge
     *
     * @return true if ACK has been found in the response from the wifi module. False otherwise or if there is no response in 5s.
     */
     int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
 
-    /*
+    /**
     * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
     *
     * @param str string to be sent
     * @param ACK string which must be acknowledge by the wifi module. If ACK == NULL, no string has to be acknoledged. (default: "NO")
     * @param res this field will contain the response from the wifi module, result of a command sent. This field is available only if ACK = "NO" AND res != NULL (default: NULL)
+    * @param timeout is the time in msec to wait for the acknowledge
     *
     * @returns true if successful
     */
     bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
     
-    /*
+    /**
     * Return true if the module is using dhcp
     *
     * @returns true if the module is using dhcp
@@ -198,6 +204,14 @@
         return state.dhcp;
     }
 
+    /**
+    * gets the host ip address
+    *
+    * @param host is a pointer to the host string to look up
+    * @param ip contains the host IP in a string after the lookup.
+    * @param sizeof_ip is the size of the buffer pointed to by ip
+    * @returns true if successful
+    */
     bool gethostbyname(const char * host, char * ip);
 
     static Wifly * getInstance() {