Revision 6:5176e0864078, committed 2013-10-17

Comitter:

screamer

Date:

Thu Oct 17 23:23:00 2013 +0000

Parent:

5:81e264dbbf03

Child:

8:04afe20d7927

Child:

10:131675c17372

Commit message:

Fixed @ return documentation tags

Changed in this revision

--- a/Wifly/Wifly.h	Thu Oct 17 23:12:55 2013 +0000
+++ b/Wifly/Wifly.h	Thu Oct 17 23:23:00 2013 +0000
@@ -73,7 +73,7 @@
     /**
     * Disconnect the wifly module from the access point
     *
-    * @ returns true if successful
+    * @return true if successful
     */
     bool disconnect();
 
@@ -82,7 +82,7 @@
     *
     * @param host host (can be either an ip address or a name. If a name is provided, a dns request will be established)
     * @param port port
-    * @ returns true if successful
+    * @return true if successful
     */
     bool connect(const char * host, int port);
 
@@ -91,7 +91,7 @@
     * Set the protocol (UDP or TCP)
     *
     * @param p protocol
-    * @ returns true if successful
+    * @return true if successful
     */
     bool setProtocol(Protocol p);
 
@@ -122,7 +122,7 @@
     /**
     * Check if a tcp link is active
     *
-    * @returns true if successful
+    * @return true if successful
     */
     bool is_connected();
 
@@ -163,7 +163,7 @@
     /**
     * Close a tcp connection
     *
-    * @ returns true if successful
+    * @return true if successful
     */
     bool close();
 
@@ -188,14 +188,14 @@
     * @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)
     *
-    * @returns true if successful
+    * @return 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
+    * @return true if the module is using dhcp
     */
     bool isDHCP() {
         return state.dhcp;

--- a/WiflyInterface.h	Thu Oct 17 23:12:55 2013 +0000
+++ b/WiflyInterface.h	Thu Oct 17 23:23:00 2013 +0000
@@ -22,8 +22,8 @@
 
 #include "Wifly.h"
 
- /** Interface using Wifly to connect to an IP-based network
- *
+ /**
+ * Interface using Wifly to connect to an IP-based network
  */
 class WiflyInterface: public Wifly {
 public:
@@ -70,7 +70,7 @@
   
   /** Get IP address
   *
-  * @ returns ip address
+  * \return ip address
   */
   char* getIPAddress();