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

Document everything via Doxygen and READMEs #26

Open
7 tasks
ahuston-0 opened this issue Jul 12, 2021 · 0 comments
Open
7 tasks

Document everything via Doxygen and READMEs #26

ahuston-0 opened this issue Jul 12, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ahuston-0
Copy link
Collaborator

ahuston-0 commented Jul 12, 2021 •
edited by dkrautha
Loading

Pretty much every .cc and .hh file in the repository needs documentation. Doxygen document generation is pretty much good to go, we just need to write it.

As for README's, we need a better project description and should write documentation for each file in /proj (our error codes, generation scripts, code stats,etc.). Since there are multiple types of scripts and configs there, we should probably just do it in a unified README in /proj

  • Audio
  • CSP
  • Data
  • OpenGL
  • Util
  • XDL
  • Video
@ahuston-0 ahuston-0 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ahuston-0