O'Reilly logo

Apache Maven 3 Cookbook by Srirangan

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Generating Javadocs with Maven

Javadoc is a documentation generator introduced by Sun Microsystems (now part of Oracle) for generating API documentation in HTML format directly from the Java source code.

Over the years, Javadoc’s format has become the de facto industry standard for documenting Java classes, methods, interfaces, and so on. It has proven to be very popular, and has transcended Java, and been readily adopted in other technologies including Microsoft .NET, PHP, ActionScript, Python, and a number of JVM-based programming languages.

The Maven Javadoc plugin uses the Javadoc tool and generates API documentation directly from the source code in HTML format.

Structure of a Javadoc comment:

 /** * @author Firstname Lastname <address @ example.com> ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required