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

Add doxygen or DocFX Support for Doc Generation #275

Open
eXpl0it3r opened this issue Sep 9, 2024 · 0 comments
Open

Add doxygen or DocFX Support for Doc Generation #275

eXpl0it3r opened this issue Sep 9, 2024 · 0 comments
Labels
Docs Feature New functionality or extending of an existing one

Comments

@eXpl0it3r
Copy link
Member

Microsoft lists three tools for documentation generation:

  • DocFX
  • Sandcastle
  • doxygen

Currently, we have support for Sandcastle in the doc/ directory, but while SFHB has been updated recently, there's no integration for VS 2022 and generally seems a tool from the past with better alternatives.

doxygen is used for SFML and could as such potentially serve as a common denominator.

image

DocFX seems quite nice and modern, utilizing the .NET ecosystem.
@eXpl0it3r eXpl0it3r added Feature New functionality or extending of an existing one Docs labels Sep 9, 2024
@eXpl0it3r eXpl0it3r mentioned this issue Sep 9, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Feature New functionality or extending of an existing one
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@eXpl0it3r