Fix doxygen warnings (2nd attempt) #851
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
This special block prevents the following strange warning message: > warning: unable to resolve reference to 'XXH_INLINE_ALL' for \ref command Since Doxyfile explicitly includes xxh_x86dispatch.c, we need special care for multiple/inconsistent document definition.
Add document for XXH3_createState() and XXH3_freeState().
Since XXH_X86DISPATCH is an internal macro, we can remove it from the document for now.
Closed
Cyan4973
approved these changes
Jul 7, 2023
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.
Follow-up of 0578efd...914458d and #831.
doxygen/to.gitignorexxh_x86dispatch.cto prevent cryptic warning due to inconsistent symbols.@reftoXXH_X86DISPATCHsince it's an internal implementaion macro.