Skip to content

Improve API functions description in mesh_dp.h #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ko80 merged 1 commit into from
Jun 18, 2025
Merged

Improve API functions description in mesh_dp.h #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions sdk/include/mesh_dp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,29 @@ int mesh_delete_client(MeshClient **mc);

/**
* @brief Create a new mesh transmitter connection.
*
* Creates a new mesh transmitter connection from the given json configuration
* structure.
*
* @param [in] mc Pointer to a parent mesh client.
* @param [out] conn Address of a pointer to the connection structure.
* @param [in] cfg Pointer to a json configuration string.
*
* @return 0 on success; an error code otherwise.
*/
int mesh_create_tx_connection(MeshClient *mc, MeshConnection **conn, const char *cfg);

/**
* @brief Create a new mesh receiver connection.
*
* Creates a new mesh receiver connection from the given json configuration
* structure.
*
* @param [in] mc Pointer to a parent mesh client.
* @param [out] conn Address of a pointer to the connection structure.
* @param [in] cfg Pointer to a json configuration string.
*
* @return 0 on success; an error code otherwise.
*/
int mesh_create_rx_connection(MeshClient *mc, MeshConnection **conn, const char *cfg);

Expand Down
Loading