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.

Sign up for GitHub

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

Jump to bottom

Add JavaDoc Comments to All Classes #8

Open
navin772 opened this issue Sep 30, 2024 · 7 comments · May be fixed by #18
Open

Add JavaDoc Comments to All Classes #8

navin772 opened this issue Sep 30, 2024 · 7 comments · May be fixed by #18
Assignees
@subhramit
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest

Comments

@navin772
Copy link
Member

The codebase currently lacks JavaDoc comments, making it harder for contributors to understand the codebase.

Adding JavaDoc comments will make the code easier to maintain and generate automatic documentation.

JavaDoc comments documentation - https://oracle.com/in/technical-resources/articles/java/javadoc-tool.html
@navin772 navin772 added hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 30, 2024
@Samyak-Waghmare
Copy link

@navin772 hey, i will work on it. Can you assign me this issue?

@Delta456
Copy link
Member

Delta456 commented Oct 2, 2024

@Samyak-Waghmare done

@navin772
Copy link
Member Author

navin772 commented Oct 3, 2024

@Samyak-Waghmare Thanks for taking this up!
You can use ./gradlew javadoc to see which warnings need to be resolved. It will show you all the classes that require documentation.

@navin772
Copy link
Member Author

@Samyak-Waghmare any updates on this?

@Samyak-Waghmare
Copy link

Hello I am unassigning myself.

@Samyak-Waghmare Samyak-Waghmare removed their assignment Oct 20, 2024
@subhramit
Copy link
Contributor

subhramit commented Nov 7, 2024 •
edited
Loading

@navin772 hey Navin, can I take this?
Also, I plan to take the help of AI to write the documentation, if that's fine.

@navin772
Copy link
Member Author

navin772 commented Nov 7, 2024

@subhramit that's fine, just verify it manually whether the documentation is actually matching what the function does

@subhramit subhramit linked a pull request Nov 11, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@subhramit subhramit

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Javadoc documentation to project subhramit/lambdatest-gradle-plugin
4 participants
@Delta456 @subhramit @navin772 @Samyak-Waghmare