Skip to content
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.

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

correct mosquitto.h return code documentation #1690

Merged
merged 1 commit into from May 20, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
correct mosquitto.h return code documentation
We currently erroneously claim that mosquitto_lib_init cannot fail,
while it can fail on Windows, if WSAStartup fails in net__init. Correct
this.

Signed-off-by: Martin Kelly <[email protected]>
  • Loading branch information
Martin Kelly committed May 18, 2020
commit 7b4668d7088431b8fda4e2ec1facf50eeaf47ab9
3 changes: 2 additions & 1 deletion lib/mosquitto.h
Expand Up @@ -202,7 +202,8 @@ libmosq_EXPORT int mosquitto_lib_version(int *major, int *minor, int *revision);
* This function is *not* thread safe.
*
* Returns:
* MOSQ_ERR_SUCCESS - always
* MOSQ_ERR_SUCCESS - on success.
* MOSQ_ERR_UNKNOWN - on Windows, if sockets couldn't be initialized.
*
* See Also:
* <mosquitto_lib_cleanup>, <mosquitto_lib_version>
Expand Down