Javadoc comments for Tutorial should be formatted using latest Java7/8 javadoc stds

Question

Javadoc comments for Tutorial should be formatted using latest Java7/8 javadoc stds

karianna opened this issue 12 years ago · 5 comments

Whilst there's not too many classes to overhaul, this is a good opportunity to get this right early. + package-info files as well.

Answer 1 · 2013-05-12T13:46:04.000Z

Hey @karianna is there a particular definitive resource describing the standards that you would recommend?

Answer 2 · 2013-05-12T14:15:35.000Z

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html is the latest (I think)

Answer 3 · 2013-05-12T21:58:11.000Z

Would this help?

http://maven-doccheck.sourceforge.net/index.html

Answer 4 · 2013-05-13T09:54:15.000Z

Hi Graham, I'm not sure, I usually just execute the Maven javadoc:javadoc goal and see what errors come out. This is also an enhancement request though as just 'fixing Javadoc bugs' doesn't mean it's nicely formatted Javadoc. I've fix the warnings to start with and we should discuss the rest further.

Answer 5 · 2013-05-13T10:55:51.000Z

Pull Requested the Javadoc fixes and I think I've fixed up most of the Javadoc, so I think this can just be closed with the PR and individual bugs raised against unreadable Javadoc.