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.

Sign up for GitHub

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

Jump to bottom

hide x86 dispatcher internals #869

Merged
merged 2 commits into from
Jul 16, 2023
Merged

hide x86 dispatcher internals #869

merged 2 commits into from
Jul 16, 2023

Conversation

t-mat
Copy link
Contributor

@t-mat t-mat commented Jul 16, 2023 •
edited
Loading

Continued from #868

(1) This PR introduces new doxygen configuration file named Doxyfile-internal.

Doxyfile is configured for the public document.

# Generate public document
doxygen
open doxygen/index.html

Doxyfile-internal is for internal development usage.

# Generate internal document
doxygen Doxyfile-internal
open doxygen/index.html

(2) This PR hides x86 dispatcher internals from public document (Doxyfile).

https://xxhash.com/doc/v0.8.2/group__dispatch.html

image

↑ becomes ↓

image

t-mat added 2 commits July 16, 2023 18:00
@t-mat
add: introduce "public" and "internal" Doxyfile
4b93d0a 
"Doxyfile" is configured to generate public document.
Differences are:
- INTERNAL_DOCS
- EXTRACT_STATIC
- EXTRACT_PRIVATE
@t-mat
fix: hide x86 dispatcher internals from document
7031f87 
Hide internals to simplify public document.
@Cyan4973 Cyan4973 merged commit d589159 into Cyan4973:dev Jul 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Cyan4973 Cyan4973 Cyan4973 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@t-mat @Cyan4973