fix Doxygen warnings #590
Merged
fix Doxygen warnings #590
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
Remove warning reported by Doxygen on doc generation: - rewrite enum documentation, - replace @ by \ref for references, - fix param names Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
The doxygen build report issue for function descriptions that provide reference to some function parameters using @: ... lib/include/openamp/rpmsg.h:160: warning: Found unknown command '\data' lib/include/openamp/rpmsg.h:160: warning: Found unknown command '\len' ... Fix the warning by replacing with back-ticks that will be interpreted as code by Markdown(Markdown support is enabled in the Doxygen configuration). Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
iuliana-prodan
approved these changes
May 8, 2024
tammyleino
approved these changes
May 15, 2024
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.
Fix warnings reported by Doxygen on the open-amp lib