Add documentation to the code

[2DSharp]

The code needs to be documented throughout with docblocks.

[vishnuvardhan2005]

I am C, C++ coder. I do not know much about Qt, image processing stuff but interested in learning and contribute to the project. Is this right one for me to pick and work-on? Please advice

[2DSharp]

Hello @vishnuvardhan2005! Although it's a Qt project, it shouldn't be very hard for a C++ programmer to get used to it quickly. You can read through the code and document them in the correct places. Read the contributing.md for some general instructions.

It's a good option to get started with open source projects.

[vishnuvardhan2005]

Hi @2DSharp Thank you. I am on Windows. I can follow the installation steps and get the software running right? Can you please elaborate on whats the exact task on the issue. Is it commenting the code? Great if you can provide an example so that I can understand correctly what needs to be done.

[2DSharp]

Read the README file to get the app running. Document the places which might have been left undocumented (using docblock comments). Check out the rest of the files which have been documented for reference.