Documentation
Closed this issue · 7 comments
Write documentation for all the classes, methods, and members, that's all. :)
Here's a checklist for all the files:
Engine:
- Component.h
- MeshRenderer.h
- DirectionalLight.h
- PointLight.h
- Tag.h
- Transform.h
- Configuration.h
- Debug.h
- Engine.h
- Entity.h
- LoopManager.h
- Macro.h
- Scene.h
- Time.h
- Window.h
- Input.h
- Key.h
- Serialization.h
- UserPointer.h
- Camera.h
- Cubemap.h
- Mesh.h
- Renderer.h
- Shader.h
- Texture.h
- Vertex.h
Editor:
- Editor.h
- EditorModules.h
For Hacktoberfest contributors: Open a PR for every 6 or more files you document, for it to be properly merged.
I would like to work on my first six: "Component.h", "MeshRenderer.h", "Tag.h", "Transform.h", "Configuration.h", "Debug.h". I cannot find "ModelExtractor.h"
@LordRibblesdale Alright! Also ModelExtractor had been removed recently, but I forgot to update the issue; though I've updated it now.
Whenever necessary, I'd like to continue in future days (I like to document code, professional deformation >.<), but I want to give others the possibility to make their PRs for Hacktoberfest ;)
Could I work on the Time.h, Window.h, Scene,h, Color.h, Key.h and Engine.h files?
By the way, I also wrote the docs for Input.h, as the key header doesn't really have much to document :D
Hello! I would like to work on Shader.h, Vertex.h, Texture.h, Key.h, PointLight.h and DirectionalLight.h