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

Documentation #15

Open
7 of 10 tasks
tumble1999 opened this issue Aug 24, 2021 · 0 comments · Fixed by #46
Open
7 of 10 tasks

Documentation #15

tumble1999 opened this issue Aug 24, 2021 · 0 comments · Fixed by #46
Assignees
@tumble1999
Labels
documentation Improvements or additions to documentation

Comments

@tumble1999
Copy link
Member

tumble1999 commented Aug 24, 2021 •
edited
Loading

To create usable doxygen generated documentation that people can use to help with developing games with the engine.

  • setup doxygen
  • setup github actions to generate docs
  • setup gtihub pages to host the docs
  • support the new folder structure
  • add it to packages
    • debian
    • arch
    • windows
  • get SArpnt to install the doxygen vscode extension and teach them how to document code
  • document all of the classes and functions
@tumble1999 tumble1999 self-assigned this Aug 24, 2021
@tumble1999 tumble1999 added the documentation Improvements or additions to documentation label Aug 24, 2021
@tumble1999 tumble1999 linked a pull request Aug 31, 2021 that will close this issue
Some Documentaion #46
Merged
@tumble1999 tumble1999 reopened this Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tumble1999 tumble1999

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Some Documentaion cinnabar-engine/cinnabar
1 participant
@tumble1999