Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

is there necessary create a package.html?

 
jin Young
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.

Thanks in advance!
 
jin Young
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.

Thanks again!
 
Justin Rundle
Ranch Hand
Posts: 123
Hibernate Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Jin,

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.
 
jin Young
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Justin,

Thanks a lot for you reply! Also i thought it better if there are package decription in javadoc.
 
Iván Párraga
Ranch Hand
Posts: 54
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

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
 
jin Young
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks Ivan.

Your mean that you create the package.html, there has package description in you javadoc. and finally,you got maximum grade?

by the way,
the private method's javadoc need be generated?

Thanks again.
 
Alecsandru Cocarla
Ranch Hand
Posts: 158
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Alberto Ivo
Ranch Hand
Posts: 39
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I'm not doing with package.html but with package-info.java.
I saw it and I Liked... The javadocs is fine.

can I do that?
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic