boards/msbiot: Added missing doc in board.h #11760
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
- Fixes warnings with current Doxygen version - Resolves issue with Doxygen linking e.g. LED0_PIN to the doc of a different board
maribu
added
Area: boards
|
@aabadie: Mind to link into this fellow up PR as well? |
aabadie
approved these changes
Jun 28, 2019
|
I built the documentation and confirm the LED macro link is fixed by this PR (my bad since I reviewed #11748). All green, let's go! |
|
Thanks for the quick review :-) It is very surprising to me that Doxygen may link to a unrelated group, even though a same named object is present in the same group. I hope that a feature to manually resolve such ambiguity will be added in future versions. I would prefer the references |
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.
Contribution description
Added missing doc to
board.hLED0_ONetc. are still linked to the LED driver for me. The documentation for\refin Doxygen indicates there is now way to specify the target group of an\refcommand to resolve ambiguity...Testing procedure
make docand check ifLED0_PIN,LED1_PINandLED2_PINare still linked to a different boardIssues/PRs references
Added
@ref LED0_PINetc. in #11748, which currently is sadly linked to an unrelated board