search

Pedro12909 / RexCord

A Discord Bot written in Java
MIT License
7 stars 4 forks source link

Improve JavaDoc Documentation #28

Open Pedro12909 opened 6 years ago

Pedro12909 commented 6 years ago

JavaDoc classes should have better documentation, expressing concisely what each class, method and variable does.

freitzzz commented 6 years ago

Starting to improve documentation on utils package

Raman1121 commented 6 years ago

Hey, I would like to work on this! Can you elaborate a bit more as to what has to be done?

Pedro12909 commented 6 years ago

@Raman1121 Take a look at each class and see if you can undestand what each method does by reading it's JavaDoc description. If you believe it doesn't properly explain what each method/variable is doing, change it. There are also some classes that have placeholder documentation. Add JavaDoc to those classes as well. Please take in mind that @freitzzz is already working on the utils package.

Also, read our wiki and CONTRIBUTING file to understand how to properly contribute to RexCord.

PS.: If you're submitting a PR as part of the Hacktoberfest event, please take in mind that submissions only count after the 1st of October.

If you have any issues, feel free to come to our Discord server and ping us! :)

Raman1121 commented 6 years ago

Sure thing ;) @Pedro12909

Pedro12909 commented 6 years ago

Assigned issue to @Raman1121 . Reference this issue in your PR once you're ready to submit your code

Raman1121 commented 6 years ago

@Pedro12909 Can I start by documenting the main package?

Pedro12909 commented 6 years ago

@Raman1121 Sure, start however you wish!

Raman1121 commented 6 years ago

@Pedro12909 Please review my PR and tell me how I can improve it.

freitzzz commented 6 years ago

Hey guys.

ATM, I'm very very busy with university, so if anyones interested in improving JavaDocs from the utils package, feel free to contribute, since I can't at this moment.

Package-info's are also accepted! (But make sure checkstyle approves your documentation!) 😛

Raman1121 commented 6 years ago

@Pedro12909 In the Travis log of my PR, it is showing that there was a checkstyle error. What style exactly will I have to follow to pass the build?

Pedro12909 commented 6 years ago

Hi @Raman1121, look in your build log for the error. It will tell you exactly what line of code is faulty. For further help, post your build log here :)