Skip to content

Commit 5b22304

Browse files
author
Amanda Butler
authored
Edit ATCmdParser.md
Make minor grammar and spelling edits.
1 parent 9210885 commit 5b22304

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

platform/ATCmdParser.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
8383
* Constructor
8484
*
8585
* @param fh A FileHandle to the digital interface, used for AT commands
86-
* @param output_delimiter End of command line termination
86+
* @param output_delimiter End of command-line termination
8787
* @param buffer_size Size of internal buffer for transaction
8888
* @param timeout Timeout of the connection
8989
* @param debug Turns on/off debug output for AT commands
@@ -114,7 +114,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
114114
/**
115115
* Allows timeout to be changed between commands
116116
*
117-
* @param timeout ATCmdParser API's (read/write/send/recv ..etc) throw an
117+
* @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
118118
* error if no response is received in `timeout` duration
119119
*/
120120
void set_timeout(int timeout)
@@ -123,13 +123,13 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
123123
}
124124

125125
/**
126-
* For backwards compatibility.
126+
* For backward compatibility.
127127
* @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.
128128
*
129129
* Please use set_timeout(int) API only from now on.
130130
* Allows timeout to be changed between commands
131131
*
132-
* @param timeout ATCmdParser API's (read/write/send/recv ..etc) throw an
132+
* @param timeout ATCmdParser APIs (read/write/send/recv ..etc) throw an
133133
* error if no response is received in `timeout` duration
134134
*
135135
*/
@@ -176,7 +176,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
176176
}
177177

178178
/**
179-
* For backwards compatibility.
179+
* For backward compatibility.
180180
* @deprecated Do not use this function. This function has been replaced with debug_on for consistency.
181181
*
182182
* Allows traces from modem to be turned on or off
@@ -296,7 +296,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
296296
/**
297297
* Abort current recv
298298
*
299-
* Can be called from oob handler to interrupt the current
299+
* Can be called from out-of-band handler to interrupt the current
300300
* recv operation.
301301
*/
302302
void abort();
@@ -307,7 +307,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
307307
* Process out-of-band data in the receive buffer. This function
308308
* returns immediately if there is no data to process.
309309
*
310-
* @return true if oob data processed, false otherwise
310+
* @return true if out-of-band data processed, false otherwise
311311
*/
312312
bool process_oob(void);
313313
};

0 commit comments

Comments
 (0)