There are two ways of adding package level documentation using javadoc:
- package-info.java
- Only from 5.0
- Preferred way
- Can contain a package declaration, package annotations, package comments and Javadoc tags
- package.html
- Any Java version
- Can not contain package declaration and/or package annotations
More details and examples are here. Which one to use: Javadoc: package.html or package-info.java