How do I generate a javadoc report for a site?
Author: Deron Eriksson
Description: This maven tutorial describes how to generate a javadoc report for a site using the Maven Javadoc Plugin.
Tutorial created using: Windows Vista || JDK 1.6.0_04 || Eclipse Web Tools Platform 2.0.1 (Eclipse 3.3.1)

Page: < 1 2

(Continued from page 1)

Now, let's look at the site reports that were generated. The project site has a JavaDocs report and a Test JavaDocs report.

Generated Reports

I clicked on the JavaDocs link. This brought me to the javadocs for the project.


Let's check the "Howdy" class. We can see that the javadocs have been generated for this class. Notice that we have links to String and StringUtils. This is because of the links configuration section for the maven-javadoc-plugin. You can see the link to StringUtils in the status bar.

JavaDocs for Howdy class

The Test JavaDocs report link will display javadocs for the JavaSW test classes.

Page: < 1 2

Related Tutorials: