gnrc_ipv6: add config macros to config doc group#10617
Merged
jia200x merged 1 commit intoRIOT-OS:masterfrom Dec 17, 2018
Merged
gnrc_ipv6: add config macros to config doc group#10617jia200x merged 1 commit intoRIOT-OS:masterfrom
jia200x merged 1 commit intoRIOT-OS:masterfrom
Conversation
miri64
added
Type: enhancement
miri64
force-pushed
the
gnrc_ipv6/enh/config-group
branch
from
948ceba to
3f17db1
Compare
miri64
commented
Dec 14, 2018
| #endif | ||
|
|
||
| /** | ||
| * @defgroup net_gnrc_ipv6_blacklist_conf GNRC IPv6 address blacklisting compile configurations |
Member
Author
There was a problem hiding this comment.
Can't really split the line, otherwise doxygen renders it as @brief. It is still within the absolute maximum though
| #endif | ||
|
|
||
| /** | ||
| * @defgroup net_gnrc_ipv6_whitelist_conf GNRC IPv6 address whitelisting compile configurations |
jia200x
reviewed
Dec 17, 2018
|
|
||
|
|
||
| /** | ||
| * @defgroup net_gnrc_ipv6_conf GNRC IPv6 compile configurations |
Member
There was a problem hiding this comment.
so, we agree all configuration groups have the <dox_module>_conf name?
Member
Author
There was a problem hiding this comment.
As long as it is clear, that they have something to do with configuration and are in the config group, I don't really care either way.
jia200x
added
the
CI: ready for build
Member
|
Looks OK to me. We might need another grouping in the future if the list of configurations keeps growing (e.g |
Member
|
Generated documentation looks ok and Doxygen doesn't report errors. |
Member
|
First PR of the #10566 series! Congratz 🎉 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Contribution description
See #10566
Testing procedure
Compile documentation. A new group for the configuration macros of
gnrc_ipv6should show up both in theconfiggroup doc as well in the doc of the respectivegnrc_ipv6(sub-)modules changed here.Issues/PRs references
Addresses #10566 in part