• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc : packages.html / overview-summary.html

 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have one embarresing question:
the packages describtion is not generated automatically, which quite logic,
because (I suppose) there is no way to put comments for packages in the code. I looked at the instruction of Sun how to inchlude the comments for packages in javadoc. As far as I understand it , I have to do it manually.
Is it correct?

Tx,
Vlad
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Vlad,
Correct. 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
 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Andrew,
Ok. Tx!
Best,
Vlad
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic