Add comments through the source code

JeanPhilippeKernel / RendererEngine

3D Renderer Engine builds with Vulkan and C++ 20

MIT License

184 stars 18 forks source link

Add comments through the source code #36

Open JeanPhilippeKernel opened 3 years ago

JeanPhilippeKernel commented 3 years ago

Currently, the whole codebase lacks comments that describe each component and their associate method or functions. it would be nice to provide comments/descriptions that can serve as documentation for existing or new contributors.

We'll follow Doxygen documentation https://www.doxygen.nl/manual/docblocks.html#cppblock

JFancis commented 2 years ago

Hi, Can i work on it

JeanPhilippeKernel commented 2 years ago

sure, I've assigned it to you

JeanPhilippeKernel commented 2 years ago

@JFancis you'll find some examples here: https://github.com/JeanPhilippeKernel/RendererEngine/blob/develop/ZEngine/include/ZEngine/Rendering/Shaders/ShaderReader.h

Doxygen is our reference: https://www.doxygen.nl/manual/docblocks.html#cppblock