TerraForge3D icon indicating copy to clipboard operation
TerraForge3D copied to clipboard

Commenting the code

Open Jaysmito101 opened this issue 2 years ago • 8 comments

This is a simple issue i would like to open for contributers to get started with TerraFoebe3D development. TerraForge3D uses a completely automatic documentation generation system. Now this system generates the docs based on comments. You can comment code like https://github.com/Jaysmito101/TerraForge3D/blob/master/TerraForge3D/include/Modules/Module.h .

To get strted you can follow the developers guide to setup TerraForge3D for development https://jaysmito101.github.io/TerraForge3D/documentation/d5/d38/md__docs_markdowns_index.html also for any help feel free to contact me at https://discord.gg/9ebyYwSktZ

Jaysmito101 avatar Mar 21 '22 11:03 Jaysmito101

i want to contribute PS assigned it to me

KushagraVarshney05 avatar Feb 01 '23 05:02 KushagraVarshney05

Hello @Jaysmito101, I'm a IWOC participant, I would like to contribute in this issue. Is it possible that an issue can be assigned to more than one contributor ?

nerdy-nakul avatar Feb 02 '23 09:02 nerdy-nakul

@nerdy-nakul sure. It's quite a big issue requiribg a lot of work so multiple people can work on it.

Jaysmito101 avatar Feb 02 '23 09:02 Jaysmito101

Hello @Jaysmito101, Could you please attach some links where i can find code for commenting.

nerdy-nakul avatar Feb 04 '23 05:02 nerdy-nakul

@nerdy-nakul the entire projects needs commenting especially for every function it should be commented in a manner doxygen would recognize

Jaysmito101 avatar Feb 04 '23 05:02 Jaysmito101

Do assign me this project as I want to contribute in this issue.

ghost avatar Feb 04 '23 17:02 ghost

Hello @Jaysmito101 I would like to contribute to this issue, plz assign it to me.

any-mesh avatar Feb 08 '23 11:02 any-mesh

@anime-sh-github if you want to contribute go ahead and start, create a pull request then I will assign

Jaysmito101 avatar Feb 08 '23 11:02 Jaysmito101