diff --git a/features/cellular/framework/API/CellularContext.h b/features/cellular/framework/API/CellularContext.h index dd76ac353c..0e3cdaa4b5 100644 --- a/features/cellular/framework/API/CellularContext.h +++ b/features/cellular/framework/API/CellularContext.h @@ -98,7 +98,7 @@ public: // pointer for next item when used as a linked list CellularContext *_next; protected: - // friend of CellularDevice so that it's the only way to close/delete this class. + // friend of CellularDevice, so it's the only way to close or delete this class. friend class CellularDevice; virtual ~CellularContext() {} @@ -109,10 +109,10 @@ public: // from NetworkInterface /** Register callback for status reporting. * - * The specified status callback function will be called on the network and cellular device status changes. - * The parameters on the callback are the event type and event-type dependent reason parameter. + * The specified status callback function is called on the network, and the cellular device status changes. + * The parameters on the callback are the event type and event type dependent reason parameter. * - * @remark deleting CellularDevice/CellularContext in callback not allowed. + * @remark deleting CellularDevice/CellularContext in callback is not allowed. * * @param status_cb The callback for status changes. */ @@ -132,13 +132,13 @@ public: // from NetworkInterface static CellularContext *get_default_instance(); -// Operations, can be sync/async. Also Connect() is this kind of operations, inherited from NetworkInterface above. +// Operations, can be sync/async. Also Connect() is this kind of operation, inherited from NetworkInterface above. /** Start the interface * - * Power on the device and does the initializations for communication with the modem.. - * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). - * In synchronous and asynchronous mode application can get result in from callback which is set with + * Powers on the device and does the initializations for communication with the modem. + * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). + * In synchronous and asynchronous mode, the application can get result in from callback, which is set with * attach(...) * * @return NSAPI_ERROR_OK on success @@ -148,9 +148,9 @@ public: // from NetworkInterface /** Start the interface * - * Attempts to open the sim. - * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). - * In synchronous and asynchronous mode application can get result in from callback which is set with + * Attempts to open the SIM. + * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). + * In synchronous and asynchronous mode, the application can get result in from callback, which is set with * attach(...) * * @return NSAPI_ERROR_OK on success @@ -161,8 +161,8 @@ public: // from NetworkInterface /** Start the interface * * Attempts to register the device to cellular network. - * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). - * In synchronous and asynchronous mode application can get result in from callback which is set with + * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). + * In synchronous and asynchronous mode, the application can get result in from callback, which is set with * attach(...) * * @return NSAPI_ERROR_OK on success @@ -173,8 +173,8 @@ public: // from NetworkInterface /** Start the interface * * Attempts to attach the device to cellular network. - * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...). - * In synchronous and asynchronous mode application can get result in from callback which is set with + * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). + * In synchronous and asynchronous mode, the application can get result in from callback, which is set with * attach(...) * * @return NSAPI_ERROR_OK on success @@ -196,7 +196,7 @@ public: // from NetworkInterface virtual nsapi_error_t get_rate_control(CellularContext::RateControlExceptionReports &reports, CellularContext::RateControlUplinkTimeUnit &time_unit, int &uplink_rate) = 0; - /** Get the relevant information for an active non secondary PDP context. + /** Get the relevant information for an active nonsecondary PDP context. * * @remark optional params are not updated if not received from network. * @param params_list reference to linked list, which is filled on successful call @@ -215,7 +215,7 @@ public: // from NetworkInterface */ virtual nsapi_error_t get_apn_backoff_timer(int &backoff_timer) = 0; - /** Set the file handle used to communicate with the modem. Can be used to change default file handle. + /** Set the file handle used to communicate with the modem. You can use this to change the default file handle. * * @param fh file handle for communicating with the modem */ @@ -232,8 +232,7 @@ protected: // Device specific implementations might need these so protected OP_MAX = 5 }; - /** Status callback function will be called on status changes on the network or CellularDevice - * by the CellularDevice. + /** The CellularDevice calls the status callback function on status changes on the network or CellularDevice. * * @param ev event type * @param ptr event-type dependent reason parameter