Copy edit PPPCellularInterface.h

Amanda Butler · adbridge · commit 6431ae2e9da0 · 2018-04-20T15:31:55.000+01:00
Copy edit file for grammar.
diff --git a/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h b/features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h
@@ -92,7 +92,7 @@ typedef struct {
 
 /** PPPCellularInterface class
  *
- *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+ *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
  *
  *  This interface serves as the controller/driver for the Cellular
  *  modems (tested with UBLOX_C027 and MTS_DRAGONFLY_F411RE).
@@ -108,7 +108,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Constructor for a generic modem, using a single FileHandle for commands and PPP data.
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      * The file handle pointer is not accessed within the constructor, only recorded for later
      * 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 {
 
     /** Destructor
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
     virtual ~PPPCellularInterface();
 
     /** Set the Cellular network credentials
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  Please check documentation of connect() for default behaviour of APN settings.
      *
@@ -139,7 +139,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Set the pin code for SIM card
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @param sim_pin      PIN for the SIM card
      */
@@ -148,7 +148,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Start the interface
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  Attempts to connect to a Cellular network.
      *  This driver is written mainly for data network connections as CellularInterface
@@ -169,7 +169,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Attempt to connect to the Cellular network
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  Brings up the network interface. Connects to the Cellular Radio
      *  network and then brings up the underlying network stack to be used
@@ -204,7 +204,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Adds or removes a SIM facility lock
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      * Can be used to enable or disable SIM pin check at device startup.
      * This API sets up flags for the driver which would either enable or disable
@@ -219,7 +219,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Change the pin for the SIM card
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      * Provide the new pin for your SIM card with this API. Old pin code will be assumed to
      * be set using set_SIM_pin() API. This API have no immediate effect. While establishing
@@ -232,7 +232,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Check if the connection is currently established or not
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      * @return true/false   If the cellular module have successfully acquired a carrier and is
      *                      connected to an external packet data network using PPP, isConnected()
@@ -243,7 +243,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Get the local IP address
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @return         Null-terminated representation of the local IP address
      *                  or null if no IP address has been received
@@ -253,7 +253,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Get the local network mask
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @return         Null-terminated representation of the local network mask
      *                  or null if no network mask has been received
@@ -263,7 +263,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Get the local gateways
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @return         Null-terminated representation of the local gateway
      *                  or null if no network mask has been received
@@ -281,7 +281,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Register callback for status reporting
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @param status_cb The callback for status changes
      */
@@ -290,7 +290,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Get the connection status
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @return         The connection status according to nsapi_connection_status_t
      */
@@ -299,7 +299,7 @@ class PPPCellularInterface : public CellularBase {
 
     /** Set blocking status of connect() which by default should be blocking
      *
-     *  @deprecated This API will be deprecated mbed-os-5.9, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
+     *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.
      *
      *  @param blocking true if connect is blocking
      *  @return         0 on success, negative error code on failure

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ typedef struct {`
`92`	`92`
`93`	`93`	`/** PPPCellularInterface class`
`94`	`94`	`*`
`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.`
`96`	`96`	`*`
`97`	`97`	`* This interface serves as the controller/driver for the Cellular`
`98`	`98`	`* modems (tested with UBLOX_C027 and MTS_DRAGONFLY_F411RE).`
`@@ -108,7 +108,7 @@ class PPPCellularInterface : public CellularBase {`
`108`	`108`
`109`	`109`	`/** Constructor for a generic modem, using a single FileHandle for commands and PPP data.`
`110`	`110`	`*`
`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.`
`112`	`112`	`*`
`113`	`113`	`* The file handle pointer is not accessed within the constructor, only recorded for later`
`114`	`114`	`* 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 {`
`118`	`118`
`119`	`119`	`/** Destructor`
`120`	`120`	`*`
`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.`
`122`	`122`	`*/`
`123`	`123`	`MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")`
`124`	`124`	`virtual ~PPPCellularInterface();`
`125`	`125`
`126`	`126`	`/** Set the Cellular network credentials`
`127`	`127`	`*`
`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.`
`129`	`129`	`*`
`130`	`130`	`* Please check documentation of connect() for default behaviour of APN settings.`
`131`	`131`	`*`
`@@ -139,7 +139,7 @@ class PPPCellularInterface : public CellularBase {`
`139`	`139`
`140`	`140`	`/** Set the pin code for SIM card`
`141`	`141`	`*`
`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.`
`143`	`143`	`*`
`144`	`144`	`* @param sim_pin PIN for the SIM card`
`145`	`145`	`*/`
`@@ -148,7 +148,7 @@ class PPPCellularInterface : public CellularBase {`
`148`	`148`
`149`	`149`	`/** Start the interface`
`150`	`150`	`*`
`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.`
`152`	`152`	`*`
`153`	`153`	`* Attempts to connect to a Cellular network.`
`154`	`154`	`* This driver is written mainly for data network connections as CellularInterface`
`@@ -169,7 +169,7 @@ class PPPCellularInterface : public CellularBase {`
`169`	`169`
`170`	`170`	`/** Attempt to connect to the Cellular network`
`171`	`171`	`*`
`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.`
`173`	`173`	`*`
`174`	`174`	`* Brings up the network interface. Connects to the Cellular Radio`
`175`	`175`	`* network and then brings up the underlying network stack to be used`
`@@ -204,7 +204,7 @@ class PPPCellularInterface : public CellularBase {`
`204`	`204`
`205`	`205`	`/** Adds or removes a SIM facility lock`
`206`	`206`	`*`
`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.`
`208`	`208`	`*`
`209`	`209`	`* Can be used to enable or disable SIM pin check at device startup.`
`210`	`210`	`* This API sets up flags for the driver which would either enable or disable`
`@@ -219,7 +219,7 @@ class PPPCellularInterface : public CellularBase {`
`219`	`219`
`220`	`220`	`/** Change the pin for the SIM card`
`221`	`221`	`*`
`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.`
`223`	`223`	`*`
`224`	`224`	`* Provide the new pin for your SIM card with this API. Old pin code will be assumed to`
`225`	`225`	`* be set using set_SIM_pin() API. This API have no immediate effect. While establishing`
`@@ -232,7 +232,7 @@ class PPPCellularInterface : public CellularBase {`
`232`	`232`
`233`	`233`	`/** Check if the connection is currently established or not`
`234`	`234`	`*`
`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.`
`236`	`236`	`*`
`237`	`237`	`* @return true/false If the cellular module have successfully acquired a carrier and is`
`238`	`238`	`* connected to an external packet data network using PPP, isConnected()`
`@@ -243,7 +243,7 @@ class PPPCellularInterface : public CellularBase {`
`243`	`243`
`244`	`244`	`/** Get the local IP address`
`245`	`245`	`*`
`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.`
`247`	`247`	`*`
`248`	`248`	`* @return Null-terminated representation of the local IP address`
`249`	`249`	`* or null if no IP address has been received`
`@@ -253,7 +253,7 @@ class PPPCellularInterface : public CellularBase {`
`253`	`253`
`254`	`254`	`/** Get the local network mask`
`255`	`255`	`*`
`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.`
`257`	`257`	`*`
`258`	`258`	`* @return Null-terminated representation of the local network mask`
`259`	`259`	`* or null if no network mask has been received`
`@@ -263,7 +263,7 @@ class PPPCellularInterface : public CellularBase {`
`263`	`263`
`264`	`264`	`/** Get the local gateways`
`265`	`265`	`*`
`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.`
`267`	`267`	`*`
`268`	`268`	`* @return Null-terminated representation of the local gateway`
`269`	`269`	`* or null if no network mask has been received`
`@@ -281,7 +281,7 @@ class PPPCellularInterface : public CellularBase {`
`281`	`281`
`282`	`282`	`/** Register callback for status reporting`
`283`	`283`	`*`
`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.`
`285`	`285`	`*`
`286`	`286`	`* @param status_cb The callback for status changes`
`287`	`287`	`*/`
`@@ -290,7 +290,7 @@ class PPPCellularInterface : public CellularBase {`
`290`	`290`
`291`	`291`	`/** Get the connection status`
`292`	`292`	`*`
`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.`
`294`	`294`	`*`
`295`	`295`	`* @return The connection status according to nsapi_connection_status_t`
`296`	`296`	`*/`
`@@ -299,7 +299,7 @@ class PPPCellularInterface : public CellularBase {`
`299`	`299`
`300`	`300`	`/** Set blocking status of connect() which by default should be blocking`
`301`	`301`	`*`
`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.`
`303`	`303`	`*`
`304`	`304`	`* @param blocking true if connect is blocking`
`305`	`305`	`* @return 0 on success, negative error code on failure`