-
Notifications
You must be signed in to change notification settings - Fork 123
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 Generation #246
Merged
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
ChrisThrasher
approved these changes
May 8, 2024
kimci86
reviewed
May 8, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Little suggestions: bugfix/doxygen-docs...kimci86:CSFML:bugfix/doxygen-docs
so that include directives are correct in the generated documentation.
kimci86
approved these changes
May 9, 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.
Similar to SFML/SFML#2986 this fixes a bunch of things:
For the missing function documentation, I'm not entirely sure if the
EXTRACT_ALL
is really enough.Yes, you can now find the functions, e.g. by going to a file or search for it, but there's no nice overview, and unfortunately, doxygen doesn't seem to have a "function" tab and in a C source the "class" tab is only partially useful.
I wonder, if it would still make sense to create modules to collect all the functions of the same SFML class in one overview page.
For now however, I believe this should be good enough.