Skip to content

Commit 8de7a36

Browse files
author
Mel W
authored
Capitalization and punctuation
1 parent 7e7af77 commit 8de7a36

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

features/nanostack/mbed-mesh-api/source/include/enet_tasklet.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,33 @@ void enet_tasklet_init(void);
3030
/*
3131
* \brief Create network interface.
3232
*
33-
* \param device_id registered physical device
34-
* \return interface ID that can be used to communication with this interface
33+
* \param device_id Registered physical device.
34+
* \return interface ID used to communication with this interface.
3535
*/
3636
int8_t enet_tasklet_network_init(int8_t device_id);
3737

3838
/*
39-
* \brief Connect to ethernet network
39+
* \brief Connect to Ethernet network.
4040
*
41-
* \param callback to be called when network state changes
42-
* \param nwk_interface_id to use for networking
41+
* \param callback Call when network state changes.
42+
* \param nwk_interface_id To use for networking.
4343
*
4444
*/
4545
int8_t enet_tasklet_connect(void (*)(mesh_connection_status_t mesh_status), int8_t nwk_interface_id);
4646

4747
/*
4848
* \brief Disconnect network interface.
4949
*
50-
* \param send_cb send possible network status change event if set to true.
50+
* \param send_cb Send possible network status change event if set to `true`.
5151
* \return >= 0 if disconnected successfully.
52-
* \return < 0 in case of errors
52+
* \return < 0 if error.
5353
*/
5454
int8_t enet_tasklet_disconnect(bool send_cb);
5555

5656
/*
57-
* \brief callback to be called when the link state changes.
57+
* \brief Callback to call when the link state changes.
5858
*
59-
* \param up tells if the link is up or down
59+
* \param up Tells if link is up or down.
6060
*/
6161
void enet_tasklet_link_state_changed(bool up);
6262

0 commit comments

Comments
 (0)