@@ -30,33 +30,33 @@ void enet_tasklet_init(void);
30
30
/*
31
31
* \brief Create network interface.
32
32
*
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.
35
35
*/
36
36
int8_t enet_tasklet_network_init (int8_t device_id );
37
37
38
38
/*
39
- * \brief Connect to ethernet network
39
+ * \brief Connect to Ethernet network.
40
40
*
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.
43
43
*
44
44
*/
45
45
int8_t enet_tasklet_connect (void (* )(mesh_connection_status_t mesh_status ), int8_t nwk_interface_id );
46
46
47
47
/*
48
48
* \brief Disconnect network interface.
49
49
*
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` .
51
51
* \return >= 0 if disconnected successfully.
52
- * \return < 0 in case of errors
52
+ * \return < 0 if error.
53
53
*/
54
54
int8_t enet_tasklet_disconnect (bool send_cb );
55
55
56
56
/*
57
- * \brief callback to be called when the link state changes.
57
+ * \brief Callback to call when the link state changes.
58
58
*
59
- * \param up tells if the link is up or down
59
+ * \param up Tells if link is up or down.
60
60
*/
61
61
void enet_tasklet_link_state_changed (bool up );
62
62
0 commit comments