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 Generation #246

Merged
merged 12 commits into from
May 9, 2024
Merged

Fix Doxygen Generation #246

merged 12 commits into from
May 9, 2024

Conversation

eXpl0it3r
Copy link
Member

@eXpl0it3r eXpl0it3r commented May 7, 2024

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.

@eXpl0it3r eXpl0it3r added the Bug label May 7, 2024
@eXpl0it3r eXpl0it3r linked an issue May 7, 2024 that may be closed by this pull request
@kimci86
Copy link
Contributor

kimci86 commented May 8, 2024

but there's no nice overview, and unfortunately, doxygen doesn't seem to have a "function" tab

It is maybe a little hidden but there is a list in Files > File Members > Functions

Capture d’écran du 2024-05-08 20-11-20

Copy link
Contributor

@kimci86 kimci86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eXpl0it3r eXpl0it3r merged commit 8c02b89 into 2.6.x May 9, 2024
36 checks passed
@eXpl0it3r eXpl0it3r deleted the bugfix/doxygen-docs branch May 9, 2024 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated CSFML documentation does not document any functions
3 participants