Skip to content

Commit 8389bbf

Browse files
author
Amanda Butler
authored
Copy edit PPPCellularInterface.h
Copy edit file for grammar.
1 parent 0f8a2c7 commit 8389bbf

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ typedef struct {
9292

9393
/** PPPCellularInterface class
9494
*
95-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
95+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
9696
*
9797
* This interface serves as the controller/driver for the Cellular
9898
* modems (tested with UBLOX_C027 and MTS_DRAGONFLY_F411RE).
@@ -108,7 +108,7 @@ class PPPCellularInterface : public CellularBase {
108108

109109
/** Constructor for a generic modem, using a single FileHandle for commands and PPP data.
110110
*
111-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
111+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
112112
*
113113
* The file handle pointer is not accessed within the constructor, only recorded for later
114114
* use - this permits a derived class to pass a pointer to a not-yet-constructed member object.
@@ -118,14 +118,14 @@ class PPPCellularInterface : public CellularBase {
118118

119119
/** Destructor
120120
*
121-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
121+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
122122
*/
123123
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
124124
virtual ~PPPCellularInterface();
125125

126126
/** Set the Cellular network credentials
127127
*
128-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
128+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
129129
*
130130
* Please check documentation of connect() for default behaviour of APN settings.
131131
*
@@ -139,7 +139,7 @@ class PPPCellularInterface : public CellularBase {
139139

140140
/** Set the pin code for SIM card
141141
*
142-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
142+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
143143
*
144144
* @param sim_pin PIN for the SIM card
145145
*/
@@ -148,7 +148,7 @@ class PPPCellularInterface : public CellularBase {
148148

149149
/** Start the interface
150150
*
151-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
151+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
152152
*
153153
* Attempts to connect to a Cellular network.
154154
* This driver is written mainly for data network connections as CellularInterface
@@ -169,7 +169,7 @@ class PPPCellularInterface : public CellularBase {
169169

170170
/** Attempt to connect to the Cellular network
171171
*
172-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
172+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
173173
*
174174
* Brings up the network interface. Connects to the Cellular Radio
175175
* network and then brings up the underlying network stack to be used
@@ -204,7 +204,7 @@ class PPPCellularInterface : public CellularBase {
204204

205205
/** Adds or removes a SIM facility lock
206206
*
207-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
207+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
208208
*
209209
* Can be used to enable or disable SIM pin check at device startup.
210210
* This API sets up flags for the driver which would either enable or disable
@@ -219,7 +219,7 @@ class PPPCellularInterface : public CellularBase {
219219

220220
/** Change the pin for the SIM card
221221
*
222-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
222+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
223223
*
224224
* Provide the new pin for your SIM card with this API. Old pin code will be assumed to
225225
* be set using set_SIM_pin() API. This API have no immediate effect. While establishing
@@ -232,7 +232,7 @@ class PPPCellularInterface : public CellularBase {
232232

233233
/** Check if the connection is currently established or not
234234
*
235-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
235+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
236236
*
237237
* @return true/false If the cellular module have successfully acquired a carrier and is
238238
* connected to an external packet data network using PPP, isConnected()
@@ -243,7 +243,7 @@ class PPPCellularInterface : public CellularBase {
243243

244244
/** Get the local IP address
245245
*
246-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
246+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
247247
*
248248
* @return Null-terminated representation of the local IP address
249249
* or null if no IP address has been received
@@ -253,7 +253,7 @@ class PPPCellularInterface : public CellularBase {
253253

254254
/** Get the local network mask
255255
*
256-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
256+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
257257
*
258258
* @return Null-terminated representation of the local network mask
259259
* or null if no network mask has been received
@@ -263,7 +263,7 @@ class PPPCellularInterface : public CellularBase {
263263

264264
/** Get the local gateways
265265
*
266-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
266+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
267267
*
268268
* @return Null-terminated representation of the local gateway
269269
* or null if no network mask has been received
@@ -281,7 +281,7 @@ class PPPCellularInterface : public CellularBase {
281281

282282
/** Register callback for status reporting
283283
*
284-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
284+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
285285
*
286286
* @param status_cb The callback for status changes
287287
*/
@@ -290,7 +290,7 @@ class PPPCellularInterface : public CellularBase {
290290

291291
/** Get the connection status
292292
*
293-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
293+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
294294
*
295295
* @return The connection status according to nsapi_connection_status_t
296296
*/
@@ -299,7 +299,7 @@ class PPPCellularInterface : public CellularBase {
299299

300300
/** Set blocking status of connect() which by default should be blocking
301301
*
302-
* @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
302+
* @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
303303
*
304304
* @param blocking true if connect is blocking
305305
* @return 0 on success, negative error code on failure

0 commit comments

Comments
 (0)