net/gcoap: add config macros to config doc group #10676
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
kb2ma
added
Area: doc
miri64
requested changes
Dec 29, 2018
|
Pushed fixups and new commit for retitle of documentation group. Looking for a response on comment about ordering of configurable macros. |
Avoids confusion with generic CoAP and capitalization retains order in documentation.
kb2ma
force-pushed
the
gcoap/doc_config_group
branch
from
233fd61 to
beae37c
Compare
kb2ma
added
the
CI: ready for build
|
Squashed and running CI build. |
miri64
reviewed
Dec 30, 2018
| @@ -270,7 +277,8 @@ extern "C" { | |||
| #define GCOAP_HEADER_MAXLEN (sizeof(coap_hdr_t) + GCOAP_TOKENLEN_MAX) | |||
|
|
|||
| /** | |||
| * @brief Length in bytes for a token; use 2 if not defined | |||
| * @ingroup net_gcoap_conf | |||
| * @brief Length in bytes for a token | |||
There was a problem hiding this comment.
Is this supposed to be in any relation to GCOAP_TOKENLEN_MAX? If yes please document.
There was a problem hiding this comment.
Good catch. Documented in 03d4230.
jia200x
added
the
Reviewed: 3-testing
|
documentation is generated accordingly and all GCOAP macros from #10566 are included here |
jia200x
added
Reviewed: 1-fundamentals
|
Let's go! :-) |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Contribution description
Adds a documentation group for the user configurable macros in gcoap, per #10566.
Also retitles the gcoap module in the source documentation from "CoAP" to "Gcoap" for clarity. We also have a Nanocoap module as well as a CoAP defines module. I plan to add a similar documentation group for the configurable macros in these other modules as well, which really triggered me to retitle here to avoid further confusion.
Testing procedure
Compile the documentation. You should see:
Issues/PRs references
Partially implements #10566