Document all the things - Githubissues

WillieCubed / chronos-android

An app that keeps track of important events on your life's timeline.

MIT License

2 stars 0 forks source link

Document all the things #8

Open WillieCubed opened 6 years ago

WillieCubed commented 6 years ago

While not a pressing matter, documentation would aid later developers that do happen to find this project useful (and myself) understand the code more quickly. Documentation for public classes and methods should include:

package-info.java files for all packages
Useful descriptions for what each method does
Possibly code samples for classes themselves
Caveats for parameters/necessary-to-know behavior