Search code examples
javapackagejavadoc

Where to put java package-level information to use by javadoc?

Some API docs contain information at package level. For example java.io contains 3 package-level sections here http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html

The sections are: "Package java.io Description", "Package Specification" and "Related Documentation".

Where should I put these sections content in my own project so that javadoc processes it in the same way?

Solution

  • create a file called package-info.java in each package

    inside do the following

    /**
 * Javadoc
 */
package my.cool.package123;