• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc for Package

 
Sam Codean
Ranch Hand
Posts: 194
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Does anyone know how to generate javadoc comments for the Package? I tried adding it before the package declaration in one class from that package but it did not work.
 
Petr Hejl
Ranch Hand
Posts: 68
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Try to google for package-info.java. It will tell you more
 
Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi

You need a package.html in each package. You can find a description in
"How to Write Doc Comments", chapter "Package-Level Comments".
You can get this document from the java.sun.com(javadoc page).

Regards M
 
Petr Hejl
Ranch Hand
Posts: 68
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
This is true for jdk1.4 and still can be used in jdk5, but starting with jdk5 the package level info (there can be more than just javadoc) should be placed in package-info.java.
 
Sam Codean
Ranch Hand
Posts: 194
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you !!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic