search

SnakeDoc / superD_legacy

A file duplication utility in pure java.
Apache License 2.0
1 stars 3 forks source link

Add JavaDoc /** some test */ to all methods and classes #21

Open SnakeDoc opened 11 years ago

SnakeDoc commented 11 years ago

This is for good 'ol documentation and so we can generate the javadoc html.

SnakeDoc commented 11 years ago

maybe you wanna take a crack at this if you have some time. basically just need to document/update for every method in every class... see examples at: https://github.com/SnakeDoc/JUtils/blob/master/src/net/snakedoc/jutils/database/_Database.java and https://github.com/SnakeDoc/JUtils/blob/master/src/net/snakedoc/jutils/database/H2.java for formatting. Using the @param and @return and @throws allows the actual html JavaDoc's to be auto-generated. Nice.

tracehagan commented 11 years ago

Will do!

Thanks,

Trace Hagan

Please excuse any errors; sent from my mobile device.

On May 14, 2013, at 12:09 PM, Jason Sipula notifications@github.com wrote:

maybe you wanna take a crack at this if you have some time. basically just need to document/update for every method in every class... see examples at: https://github.com/SnakeDoc/JUtils/blob/master/src/net/snakedoc/jutils/database/_Database.java and https://github.com/SnakeDoc/JUtils/blob/master/src/net/snakedoc/jutils/database/H2.java for formatting. Using the @param and @return and @throws allows the actual html JavaDoc's to be auto-generated. Nice.

— Reply to this email directly or view it on GitHub.

SnakeDoc commented 11 years ago

thanks! or at least the core methods in each class. def. the ones we'll talk about for the presentation. :)