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

How to include package info into Javadocs

 
MF Tang
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
No problem generating the descriptions for attributes, methods, constructors and classes into Java doc, but where do I put in the description for a Package to be included in the Javadoc? Specificately the overview-summary.html. The package description is always blank.

 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi MF,

You create a file named "package.html" in each package directory. A simple sample could be:



Refer to the Javadoc manual for more details of what can go into this file.

Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic