search

LambdaTest / lambdatest-gradle-plugin

Other
1 stars 7 forks source link

Add JavaDoc Comments to All Classes #8

Open navin772 opened 2 weeks ago

navin772 commented 2 weeks ago

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

Samyak-Waghmare commented 1 week ago

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

Delta456 commented 1 week ago

@Samyak-Waghmare done

navin772 commented 1 week ago

@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.