Added deprecation notes to old cellular interfaces.

pull/6264/head
Teppo Järvelin 2018-02-27 14:19:09 +02:00
parent fe2e4a3680
commit bee31ad1b3
7 changed files with 17 additions and 0 deletions

View File

@ -24,6 +24,8 @@
*
* Common interface that is shared between ethernet hardware
* @addtogroup netsocket
*
* @attention CellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
class CellularInterface : public NetworkInterface
{

View File

@ -23,6 +23,8 @@
/**
* OnboardCellularInterface is an on-board specific implementation.
*
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
OnboardCellularInterface::OnboardCellularInterface(bool debug) :
UARTCellularInterface(MDMTXD, MDMRXD, MDMDCD, MDMRTS,

View File

@ -31,6 +31,8 @@ typedef mbed::EasyCellularConnection OnboardCellularInterface;
* Depending on the type of on-board modem, OnboardCellularInterface
* could be derived from different implementation classes.
* Portable applications should only rely on it being a CellularBase.
*
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
class OnboardCellularInterface : public UARTCellularInterface {

View File

@ -14,6 +14,10 @@
*/
#include "PPPCellularInterface.h"
/**
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
#if NSAPI_PPP_AVAILABLE
#include <string.h>

View File

@ -98,6 +98,8 @@ typedef struct {
* The driver will work with any generic FileHandle, and can be
* derived from in order to provide forms for specific interfaces, as well as
* adding extra power and reset controls alongside the FileHandle.
*
* @attention This API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
class PPPCellularInterface : public CellularBase {

View File

@ -14,6 +14,9 @@
*/
#include "UARTCellularInterface.h"
/**
* @attention UARTCellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
#if NSAPI_PPP_AVAILABLE
UARTCellularInterface::UARTCellularInterface(PinName txd, PinName rxd, PinName dcd, PinName rts, PinName cts, PinName ri,

View File

@ -28,6 +28,8 @@
*
* It constructs a FileHandle and passes it back to its base class as well as overrides
* enable_hup() in the base class.
*
* @attention UARTCellularInterface API will be deprecated, use mbed-os/features/cellular/framework/API instead.
*/
class UARTCellularInterface : public PPPCellularInterface {