Hello, ranches. There is on problem just like subject.
Javadoc may need a package.html to create a package description. If there has not this files, the packages description(in the packages table) will be display blanks.
you know, in java api spec there have package description for every package. for example: java.applet Provides the classes necessary to create an applet and the classes an applet uses to communicate with its applet context.
With your problem pertaining to the package html files, I cant really state if this is required or not, however I did create a html file for each package.
This allows your generated javadocs to appear more professional and describes the content of the package instead of a blank table. This would definitely be helpful to an invigilator.
I documented every single method (even when it was copy & paste from an overriden or implemented method) and package. Not sure if it was a requirement but I got maximum grade at the doc section.
Cheers,
Iv�n
Iván Párraga García
SCWCD 5, SCJD, SCJP 5, MySQL 5 DBA
Originally posted by Iv�n P�rraga: I documented every single method (even when it was copy & paste from an overriden or implemented method) and package.
Instead of copy/paste, you can simply use /**{@inheritDoc}*/. It does the same thing, and it's easier to maintain.