Revision 9:5afc5b4e2df8, committed 2014-07-25

Comitter:

screamer

Date:

Fri Jul 25 10:42:42 2014 +0000

Parent:

8:180feb3ebe62

Commit message:

Fix documentation

Changed in this revision

--- a/GPRS/GPRS.h	Tue May 06 03:56:03 2014 +0000
+++ b/GPRS/GPRS.h	Fri Jul 25 10:42:42 2014 +0000
@@ -35,6 +35,9 @@
     UDP    = 2,
 };
 
+/** The GPRS class
+ *
+ */
 class GPRS: public Modem
 {
 
@@ -49,7 +52,7 @@
      */
     GPRS(PinName tx, PinName rx, int baudRate, const char* apn, const char* userName = NULL, const char *passWord = NULL);
 
-    /** get instance of GPRS class
+    /** Get instance of GPRS class
      */
     static GPRS* getInstance() {
         return inst;
@@ -91,18 +94,18 @@
      */
     void reset();
 
-    /**	check if GPRS module is readable or not
+    /**	Check if GPRS module is readable or not
      *	@returns true if readable
      */
     bool readable(void);
 
-    /**	wait a few time to check if GPRS module is readable or not
+    /**	Wait a few time to check if GPRS module is readable or not
      *	@param socket socket
      *	@param wait_time time of waiting
      */
     int wait_readable(int socket, int wait_time);
 
-    /**	wait a few time to check if GPRS module is writeable or not
+    /**	Wait a few time to check if GPRS module is writeable or not
      *	@param socket socket
      *	@param wait_time time of waiting
      */
@@ -113,7 +116,7 @@
      */
     bool is_connected(int socket);
 
-    /** send data to socket
+    /** Send data to socket
      *	@param socket socket
      *	@param str string to be sent
      * 	@param len string length
@@ -121,7 +124,7 @@
      */
     int send(int socket, const char * str, int len);
 
-    /** read data from socket
+    /** Read data from socket
      * 	@param socket socket
      *	@param buf buffer that will store the data read from socket
      *	@param len string length need to read from socket
@@ -129,7 +132,7 @@
      */
     int recv(int socket, char* buf, int len);
 
-    /** convert the host to ip
+    /** Convert the host to ip
      *  @param host host ip string, ex. 10.11.12.13
      *  @param ip long int ip address, ex. 0x11223344
      *  @returns true if successful