Skip to content

docs: add Doxyfile and .gitignore #10

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

aanas-sayed
Copy link

@aanas-sayed aanas-sayed commented May 16, 2025

Description:

This PR adds a Doxyfile and a .gitignore to the repository.

  • The project already included Doxygen-style comments, but no Doxyfile was present. This meant that users wanting to generate documentation had to create their own Doxyfile.
  • Without a .gitignore, running Doxygen produces a large number of untracked files that clutter git status and risk accidental commits especially when using the repo as a submodule.

Output:
image

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