Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commenting the code #33

Open
Jaysmito101 opened this issue Mar 21, 2022 · 8 comments
Open

Commenting the code #33

Jaysmito101 opened this issue Mar 21, 2022 · 8 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Jaysmito101
Copy link
Owner

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 Jaysmito101 pinned this issue Mar 21, 2022
@Jaysmito101 Jaysmito101 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Mar 21, 2022
@KushagraVarshney05
Copy link

i want to contribute PS assigned it to me

@nerdy-nakul
Copy link

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 ?

@Jaysmito101
Copy link
Owner Author

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

@nerdy-nakul
Copy link

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

@Jaysmito101
Copy link
Owner Author

Jaysmito101 commented Feb 4, 2023

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

@ghost
Copy link

ghost commented Feb 4, 2023

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

@Jaysmito101 Jaysmito101 removed the iwoc label Feb 4, 2023
@any-mesh
Copy link

any-mesh commented Feb 8, 2023

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

@Jaysmito101
Copy link
Owner Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants