Skip to content

Commit 63087fe

Browse files
authored
Improve API functions description in mesh_dp.h (#402)
Signed-off-by: Konstantin Ilichev <[email protected]>
1 parent f2494bb commit 63087fe

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

sdk/include/mesh_dp.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,17 +131,29 @@ int mesh_delete_client(MeshClient **mc);
131131

132132
/**
133133
* @brief Create a new mesh transmitter connection.
134+
*
135+
* Creates a new mesh transmitter connection from the given json configuration
136+
* structure.
137+
*
134138
* @param [in] mc Pointer to a parent mesh client.
135139
* @param [out] conn Address of a pointer to the connection structure.
136140
* @param [in] cfg Pointer to a json configuration string.
141+
*
142+
* @return 0 on success; an error code otherwise.
137143
*/
138144
int mesh_create_tx_connection(MeshClient *mc, MeshConnection **conn, const char *cfg);
139145

140146
/**
141147
* @brief Create a new mesh receiver connection.
148+
*
149+
* Creates a new mesh receiver connection from the given json configuration
150+
* structure.
151+
*
142152
* @param [in] mc Pointer to a parent mesh client.
143153
* @param [out] conn Address of a pointer to the connection structure.
144154
* @param [in] cfg Pointer to a json configuration string.
155+
*
156+
* @return 0 on success; an error code otherwise.
145157
*/
146158
int mesh_create_rx_connection(MeshClient *mc, MeshConnection **conn, const char *cfg);
147159

0 commit comments

Comments
 (0)