Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doxygen warnings #850

Closed
wants to merge 6 commits into from
Closed

Conversation

t-mat
Copy link
Contributor

@t-mat t-mat commented Jul 5, 2023

Follow-up of 0578efd...914458d and #831.

  • Add doxygen/ to .gitignore
  • Add special block to xxh_x86dispatch.c to prevent cryptic warning due to inconsistent symbols.
  • Add missing documents.
  • Remove @ref to XXH_X86DISPATCH since it's an internal implementaion macro.

t-mat added 6 commits July 5, 2023 21:16
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.
@t-mat t-mat closed this Jul 5, 2023
@t-mat
Copy link
Contributor Author

t-mat commented Jul 5, 2023

Closing. Because subject line of e1e8d78 accidentaly contains @ which provokes eternal mentions. Sorry!

fix: remove @ref for XXH_X86DISPATCH

@t-mat
Copy link
Contributor Author

t-mat commented Jul 5, 2023

2nd attempt: #851

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant