ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Capitalization and punctuation

pull/9034/head
Mel W 2018-12-12 11:38:10 +02:00 committed by GitHub
parent 7e7af773ea
commit 8de7a36061
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -30,16 +30,16 @@ void enet_tasklet_init(void);
/* /*
* \brief Create network interface. * \brief Create network interface.
* *
* \param device_id registered physical device * \param device_id Registered physical device.
* \return interface ID that can be used to communication with this interface * \return interface ID used to communication with this interface.
*/ */
int8_t enet_tasklet_network_init(int8_t device_id); int8_t enet_tasklet_network_init(int8_t device_id);
/* /*
* \brief Connect to ethernet network * \brief Connect to Ethernet network.
* *
* \param callback to be called when network state changes * \param callback Call when network state changes.
* \param nwk_interface_id to use for networking * \param nwk_interface_id To use for networking.
* *
*/ */
int8_t enet_tasklet_connect(void (*)(mesh_connection_status_t mesh_status), int8_t nwk_interface_id); int8_t enet_tasklet_connect(void (*)(mesh_connection_status_t mesh_status), int8_t nwk_interface_id);
@ -47,16 +47,16 @@ int8_t enet_tasklet_connect(void (*)(mesh_connection_status_t mesh_status), int8
/* /*
* \brief Disconnect network interface. * \brief Disconnect network interface.
* *
* \param send_cb send possible network status change event if set to true. * \param send_cb Send possible network status change event if set to `true`.
* \return >= 0 if disconnected successfully. * \return >= 0 if disconnected successfully.
* \return < 0 in case of errors * \return < 0 if error.
*/ */
int8_t enet_tasklet_disconnect(bool send_cb); int8_t enet_tasklet_disconnect(bool send_cb);
/* /*
* \brief callback to be called when the link state changes. * \brief Callback to call when the link state changes.
* *
* \param up tells if the link is up or down * \param up Tells if link is up or down.
*/ */
void enet_tasklet_link_state_changed(bool up); void enet_tasklet_link_state_changed(bool up);