Merge branch 'deepikabhavnani-atcmd_docs' into rollup2

Author: Cruz Monrreal II

platform/ATCmdParser.h

@@ -82,11 +82,11 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Constructor
      *
-     * @param fh A FileHandle to a digital interface to use for AT commands
-     * @param output_delimiter end of command line termination
-     * @param buffer_size size of internal buffer for transaction
-     * @param timeout timeout of the connection
-     * @param debug turns on/off debug output for AT commands
+     * @param fh A FileHandle to the digital interface, used for AT commands
+     * @param output_delimiter End of command-line termination
+     * @param buffer_size Size of internal buffer for transaction
+     * @param timeout Timeout of the connection
+     * @param debug Turns on/off debug output for AT commands
      */
     ATCmdParser(FileHandle *fh, const char *output_delimiter = "\r",
                 int buffer_size = 256, int timeout = 8000, bool debug = false)
@@ -114,21 +114,24 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Allows timeout to be changed between commands
      *
-     * @param timeout timeout of the connection
+     * @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
+     *                error if no response is received in `timeout` duration
      */
     void set_timeout(int timeout)
     {
         _timeout = timeout;
     }
 
     /**
-     * For backwards compatibility.
+     * For backward compatibility.
      * @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.
      *
      * Please use set_timeout(int) API only from now on.
      * Allows timeout to be changed between commands
      *
-     * @param timeout timeout of the connection
+     * @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
+     *                error if no response is received in `timeout` duration
+     *
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with set_timeout for consistency")
     void setTimeout(int timeout)
@@ -139,7 +142,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Sets string of characters to use as line delimiters
      *
-     * @param output_delimiter string of characters to use as line delimiters
+     * @param output_delimiter String of characters to use as line delimiters
      */
     void set_delimiter(const char *output_delimiter)
     {
@@ -165,20 +168,20 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Allows traces from modem to be turned on or off
      *
-     * @param on set as 1 to turn on traces and vice versa.
+     * @param on Set as 1 to turn on traces and vice versa.
      */
     void debug_on(uint8_t on)
     {
         _dbg_on = (on) ? 1 : 0;
     }
 
     /**
-     * For backwards compatibility.
+     * For backward compatibility.
      * @deprecated Do not use this function. This function has been replaced with debug_on for consistency.
      *
      * Allows traces from modem to be turned on or off
      *
-     * @param on set as 1 to turn on traces and vice versa.
+     * @param on Set as 1 to turn on traces and vice versa.
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with debug_on for consistency")
     void debugOn(uint8_t on)
@@ -237,17 +240,17 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Write an array of bytes to the underlying stream
      *
-     * @param data the array of bytes to write
-     * @param size number of bytes to write
+     * @param data The array of bytes to write
+     * @param size Number of bytes to write
      * @return number of bytes written or -1 on failure
      */
     int write(const char *data, int size);
 
     /**
      * Read an array of bytes from the underlying stream
      *
-     * @param data the destination for the read bytes
-     * @param size number of bytes to read
+     * @param data The buffer for filling the read bytes
+     * @param size Number of bytes to read
      * @return number of bytes read or -1 on failure
      */
     int read(char *data, int size);
@@ -256,8 +259,8 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
      * Direct printf to underlying stream
      * @see printf
      *
-     * @param format format string to pass to printf
-     * @param ... arguments to printf
+     * @param format Format string to pass to printf
+     * @param ... Variable arguments to printf
      * @return number of bytes written or -1 on failure
      */
     int printf(const char *format, ...) MBED_PRINTF_METHOD(1, 2);
@@ -268,8 +271,8 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
      * Direct scanf on underlying stream
      * @see scanf
      *
-     * @param format format string to pass to scanf
-     * @param ... arguments to scanf
+     * @param format Format string to pass to scanf
+     * @param ... Variable arguments to scanf
      * @return number of bytes read or -1 on failure
      */
     int scanf(const char *format, ...) MBED_SCANF_METHOD(1, 2);
@@ -279,8 +282,8 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Attach a callback for out-of-band data
      *
-     * @param prefix string on when to initiate callback
-     * @param func callback to call when string is read
+     * @param prefix String on when to initiate callback
+     * @param func Callback to call when string is read
      * @note out-of-band data is only processed during a scanf call
      */
     void oob(const char *prefix, mbed::Callback<void()> func);
@@ -293,7 +296,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     /**
      * Abort current recv
      *
-     * Can be called from oob handler to interrupt the current
+     * Can be called from out-of-band handler to interrupt the current
      * recv operation.
      */
     void abort();
@@ -304,7 +307,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
     * Process out-of-band data in the receive buffer. This function
     * returns immediately if there is no data to process.
     *
-    * @return true if oob data processed, false otherwise
+    * @return true if out-of-band data processed, false otherwise
     */
     bool process_oob(void);
 };