Skip to content

Use Doxygen for generating documentation #50

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
Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Use Doxygen for generating documentation #50

wants to merge 1 commit into from

Conversation

faheel
Copy link
Owner

@faheel faheel commented Sep 7, 2019 •
edited
Loading

  • Add Doxyfile
  • Update comments using the Doxygen style
  • Use the README as the documentation's main page
  • Update Doxyfile to be more compatible with a single class project like BigInt (remove class list and a few other nav sections (to be decided))
  • Create a setup for the generated docs to be published via GitHub Pages

Closes #4.

@faheel faheel added the docs Documentation label Sep 7, 2019
@faheel faheel added this to the v1.0 milestone Sep 7, 2019
This was referenced Sep 7, 2019
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Documentation
Projects
None yet
Milestone
v1.0
Development

Successfully merging this pull request may close these issues.

Automate documentation generation
2 participants
@faheel @FloatingFowl