Copy edit OnboardCellularInterface.h

Copy edit file for active voice and removal of Latin abbreviations.
pull/6082/head
Amanda Butler 2018-02-28 21:05:15 -06:00 committed by Ari Parkkila
parent dce649c97d
commit a302a4be6d
1 changed files with 6 additions and 6 deletions

View File

@ -43,16 +43,16 @@ public:
protected: protected:
/** Sets the modem up for powering on /** Sets the modem up for powering on
* *
* modem_init() is equivalent to plugging in the device, e.g., attaching power and serial port. * modem_init() is equivalent to plugging in the device, for example, attaching power and serial port.
* Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target. * Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
*/ */
virtual void modem_init(); virtual void modem_init();
/** Sets the modem in unplugged state /** Sets the modem in unplugged state
* *
* modem_deinit() will be equivalent to pulling the plug off of the device, i.e., detaching power * modem_deinit() will be equivalent to pulling the plug off of the device, in other words, detaching power
* and serial port. This puts the modem in lowest power state. * and serial port. This puts the modem in lowest power state.
* Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target. * Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
*/ */
virtual void modem_deinit(); virtual void modem_deinit();
@ -60,14 +60,14 @@ protected:
* *
* modem_power_up() is equivalent to pressing the soft power button. * modem_power_up() is equivalent to pressing the soft power button.
* The driver may repeat this if the modem is not responsive to AT commands. * The driver may repeat this if the modem is not responsive to AT commands.
* Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target. * Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
*/ */
virtual void modem_power_up(); virtual void modem_power_up();
/** Powers down the modem /** Powers down the modem
* *
* modem_power_down() is equivalent to turning off the modem by button press. * modem_power_down() is equivalent to turning off the modem by button press.
* Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target. * Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.
*/ */
virtual void modem_power_down(); virtual void modem_power_down();
}; };