Fix doxygen errors in v3 MQTT documentation #854
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarenameas
reviewed
Apr 3, 2020
| @@ -61,6 +61,7 @@ extern "C" { | |||
| #include "threads_interface.h" | |||
| #endif | |||
|
|
|||
| /** Greatest packet identifier, per MQTT spec */ | |||
There was a problem hiding this comment.
Do we need periods here?
There was a problem hiding this comment.
The documentation for this version does not put periods at the end of lines. So for consistency, no.
There was a problem hiding this comment.
There was a problem hiding this comment.
That's v4 though. v3 does not do that.
sarenameas
reviewed
Apr 3, 2020
| CONNACK_SERVER_UNAVAILABLE_ERROR = 3, /**< Server unavailable */ | ||
| CONNACK_BAD_USERDATA_ERROR = 4, /**< Bad username */ | ||
| CONNACK_NOT_AUTHORIZED_ERROR = 5 /**< Not authorized */ | ||
| } MQTT_Connack_Return_Codes; | ||
|
|
||
| /** | ||
| * Determines the length of the MQTT connect packet that would be produced using the supplied connect options. |
There was a problem hiding this comment.
These parameters not matching in these static function don't matter?
There was a problem hiding this comment.
static functions in v3 aren't documented in doxygen.
I considered removing the docs for static functions, but it may still be helpful for people modifying the code.
sarenameas
previously approved these changes
Apr 3, 2020
dan4thewin
previously approved these changes
Apr 3, 2020
dan4thewin
approved these changes
Apr 3, 2020
sarenameas
approved these changes
Apr 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves doxygen issues in v3 MQTT documentation
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.