Skip to content

Commit 609b0f7

Browse files
author
Teppo Järvelin
committed
Cellular: minor doxygen fixes.
1 parent 8385b19 commit 609b0f7

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

features/cellular/framework/API/CellularDevice.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ class CellularDevice {
5555
*/
5656
virtual events::EventQueue *get_queue() const;
5757

58-
/** Get filehandle
58+
/** Get file handle
5959
*
60-
* @return Filehandle used in CellularDevice. With AT it's UARTSerial.
60+
* @return File handle used in CellularDevice. For example with AT it's UARTSerial.
6161
*/
6262
FileHandle &get_filehandle() const;
6363

@@ -71,13 +71,13 @@ class CellularDevice {
7171

7272
public:
7373

74-
/** Creates a new CellularContext interface. There can be multiple CellularContext interfaces unlike
74+
/** Creates a new CellularContext interface. There can be multiple CellularContext interfaces unlike interface opened with
7575
* open_xxx(...) methods.
7676
*
7777
* @param fh file handle used in communication to modem. Can be for example UART handle. If null then the default
7878
* file handle is used.
7979
* @param apn access point to use with context, can be null.
80-
* @param stack stack to be used when finding suitable PDP context
80+
* @param stack stack type to be used when finding suitable PDP context
8181
*
8282
* @return new instance of class CellularContext or NULL in case of failure
8383
*

features/cellular/framework/AT/AT_CellularDevice.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,14 @@ class AT_CellularDevice : public CellularDevice {
8989

9090
protected:
9191

92+
/** Creates new instance of AT_CellularContext or if overridden, modem specific implementation.
93+
*
94+
* @param at ATHandler reference for communication with the modem.
95+
* @param apn access point to use with context
96+
* @param stack stack type to be used when finding suitable PDP context
97+
* @return new instance of class AT_CellularContext
98+
*
99+
*/
92100
virtual AT_CellularContext *create_context_impl(ATHandler &at, const char *apn, nsapi_ip_stack_t stack);
93101

94102
/** Create new instance of AT_CellularNetwork or if overridden, modem specific implementation.

0 commit comments

Comments
 (0)