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 Library Files #7

Open
jpaoneMines opened this issue Nov 5, 2021 · 7 comments
Open

Document Library Files #7

jpaoneMines opened this issue Nov 5, 2021 · 7 comments
Assignees
@jpaoneMines
Labels
enhancement

Comments

@jpaoneMines
Copy link
Owner

Choose a standard documenting style and properly document all of the files. Ideally build HTML doc pages from comments.
jpaoneMines added a commit that referenced this issue Dec 8, 2022
@jpaoneMines
Cleaning up comments per Issue #7
63eea20
jpaoneMines added a commit that referenced this issue Aug 18, 2023
@jpaoneMines
Issue #7 - improving documentation
b8a9d6d
jpaoneMines added a commit that referenced this issue Aug 18, 2023
@jpaoneMines
Issue #7 - renaming doc/html to docs
0b69bee
jpaoneMines added a commit that referenced this issue Aug 18, 2023
@jpaoneMines
Issue #7 - created doxygen mainpage
b10da1e
jpaoneMines added a commit that referenced this issue Aug 21, 2023
@jpaoneMines
Issue #7: improving camera class documentation
7c10035
jpaoneMines added a commit that referenced this issue Aug 21, 2023
@jpaoneMines
Issue #7 - fixing file name in documentation
184b24b
jpaoneMines added a commit that referenced this issue Aug 21, 2023
@jpaoneMines
Issue #7 - improving web documentation
9539bbf
jpaoneMines added a commit that referenced this issue Aug 21, 2023
@jpaoneMines
Issue #7 - removing CSCI441_INTERNAL from web documentation
dfb8b5e
jpaoneMines added a commit that referenced this issue Aug 24, 2023
@jpaoneMines
Issue #7 - consistent and improved web documentation as well as inter…
a78d07a 
…nal commenting style
@jpaoneMines
Copy link
Owner Author

Files left to do:

  • ShaderProgram
  • ModelLoader
  • OpenGLEngine
  • OpenGL3DEngine
  • objects

jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Moved GLEW setup/cleanup to be private as well as Issue #7 improving …
e381969 
…consistent web documentation
@jpaoneMines
Copy link
Owner Author

Files left to do:

  • ShaderProgram
  • ModelLoader
  • OpenGL3DEngine
  • objects

@jpaoneMines
Copy link
Owner Author

Files left to do:

  • ShaderProgram
  • ModelLoader
  • objects

@jpaoneMines jpaoneMines self-assigned this Aug 25, 2023
@jpaoneMines
Copy link
Owner Author

Files left to do:

  • ShaderProgram
  • ModelLoader

@jpaoneMines
Copy link
Owner Author

Files left to do:

  • ShaderProgram

jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Issue #7 - improving web documentation in consistent style
baa9a28
jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Issue #7 - improving web documentation
4d11616
jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Issue #7 - improving web documentation
2a514ab
jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Issue #7 - fixing documentation
5916862
jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Issue #7 - cleaning up web documentation
39b154d
jpaoneMines added a commit that referenced this issue Aug 25, 2023
@jpaoneMines
Issue #7 - improving web documentation
70e75d8
@jpaoneMines
Copy link
Owner Author

All files complete for public facing methods

@jpaoneMines
Copy link
Owner Author

To Do:

Document internal functionality to remove the veil of what is going on behind the scenes

jpaoneMines added a commit that referenced this issue Sep 7, 2023
@jpaoneMines
Issue #7 - documented private members
cb11e9d
jpaoneMines added a commit that referenced this issue Sep 7, 2023
@jpaoneMines
Issue #7 - documented private members
4fb576f
jpaoneMines added a commit that referenced this issue Sep 14, 2023
@jpaoneMines
Issue #7 - clarifying online documentation for files
90659b6
jpaoneMines added a commit that referenced this issue Sep 20, 2023
@jpaoneMines
Issue #7 - adding documentation
38cf644
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jpaoneMines jpaoneMines

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jpaoneMines