RendererEngine icon indicating copy to clipboard operation
RendererEngine copied to clipboard

Add comments through the source code

Open JeanPhilippeKernel opened this issue 5 years ago • 3 comments

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

JeanPhilippeKernel avatar Oct 14 '20 01:10 JeanPhilippeKernel

Hi, Can i work on it

JFancis avatar Nov 03 '21 09:11 JFancis

sure, I've assigned it to you

JeanPhilippeKernel avatar Nov 03 '21 19:11 JeanPhilippeKernel

@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

JeanPhilippeKernel avatar Nov 07 '21 23:11 JeanPhilippeKernel