ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit PPPCellularInterface.h 

Copy edit file for grammar.
pull/6652/head
Amanda Butler 2018-04-17 11:49:20 -05:00 committed by GitHub
parent 0f8a2c75e7
commit 8389bbfc61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
features/netsocket/cellular/generic_modem_driver/PPPCellularInterface.h
View File

@ -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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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 @@ public:
/** 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