Fix doxygen warnings in MQTT Library documentation #1122
Merged
Conversation
This file contains hidden or 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
Add documentation to mqtt_lightweight.c Add all words to the lexicon.txt
Codecov Report
@@ Coverage Diff @@
## development #1122 +/- ##
===============================================
+ Coverage 96.54% 98.85% +2.30%
===============================================
Files 9 4 -5
Lines 5643 1309 -4334
Branches 641 393 -248
===============================================
- Hits 5448 1294 -4154
+ Misses 9 0 -9
+ Partials 186 15 -171
Continue to review full report at Codecov.
|
sarenameas
commented
Aug 13, 2020
| typedef void (* MQTTEventCallback_t )( MQTTContext_t * pContext, | ||
| MQTTPacketInfo_t * pPacketInfo, | ||
| MQTTDeserializedInfo_t * pDeserializedInfo ); | ||
| typedef void (* MQTTEventCallback_t )( struct MQTTContext * pContext, |
There was a problem hiding this comment.
There are no misra issues or compiler warnings with this change.
sarenameas
commented
Aug 13, 2020
| */ | ||
| #define MQTT_PUBLISH_ACK_PACKET_SIZE ( 4UL ) | ||
|
|
||
| struct MQTTFixedBuffer; |
There was a problem hiding this comment.
Doxygen does not easily support forward declarations like this, so i changed to our original style of typedef struct mystruct {} mystruct_t;
sarenameas
commented
Aug 13, 2020
| static size_t getRemainingLength( TransportRecv_t recvFunc, | ||
| NetworkContext_t * pNetworkContext ); | ||
|
|
||
| /** |
There was a problem hiding this comment.
Most of this is copied from the v4_beta docs with updates for new parameters and return code names.
leegeth
reviewed
Aug 13, 2020
leegeth
reviewed
Aug 13, 2020
muneebahmed10
previously approved these changes
Aug 17, 2020
muneebahmed10
previously approved these changes
Aug 17, 2020
leegeth
previously approved these changes
Aug 18, 2020
cobusve
previously approved these changes
Aug 18, 2020
sarenameas
dismissed stale reviews from cobusve, leegeth, and muneebahmed10
via
3a31641
cobusve
approved these changes
Aug 18, 2020
leegeth
approved these changes
Aug 18, 2020
leegeth
pushed a commit
to leegeth/aws-iot-device-sdk-embedded-C
that referenced
this pull request
Aug 27, 2020
Ignore private functions in mqtt_state.h and .c
leegeth
pushed a commit
to leegeth/aws-iot-device-sdk-embedded-C
that referenced
this pull request
Aug 28, 2020
Ignore private functions in mqtt_state.h and .c
leegeth
pushed a commit
to leegeth/aws-iot-device-sdk-embedded-C
that referenced
this pull request
Aug 31, 2020
Ignore private functions in mqtt_state.h and .c
leegeth
pushed a commit
to leegeth/aws-iot-device-sdk-embedded-C
that referenced
this pull request
Sep 1, 2020
Ignore private functions in mqtt_state.h and .c
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Doxygen configs and other infrastructure is to be in a separate PR.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.