Added by Erik Drolshammer, last edited by Erik Drolshammer on Jul 31, 2008  (view change)

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Technical Site and reporting

Reporting is implemented by "Plugins which generate reports, are configured as reports in the POM and run under the site generation lifecycle.". The tables below show some of the most popular of these plugins.

From the official plugin overview :
Name Description
changelog Generate a list of recent changes from your SCM.
changes Generate a report from issue tracking or a change document.
checkstyle Generate a checkstyle report.
clover Generate a Clover report. NOTE: Moved to Atlassian.com
doap Generate a Description of a Project (DOAP) file from a POM.
docck Documentation checker plugin.
javadoc Generate Javadoc for the project.
jxr Generate cross-referenced source code for easy navigation in a browser
pmd Generate a PMD report.
project-info-reports Generate standard project reports.
surefire-report Generate a report based on the results of unit tests.
Others
Taglist Generate a list of tasks based on tags in your code. E.g. TODO, FIXME etc.
JDependGenerate a list of tasks based on tags in your code.] Module/library dependency report
Cobertura Test code coverage report
SchemaSpy documentation for your database

How to get graphical UML diagrams in the javadoc

  • Install graphviz in Debian (apt) based systems
    aptitude install graphviz
    
  • Install Graphviz on CentOS 4.6
    yum install libtool-libs
    yum install urw-fonts
    wget http://www.graphviz.org/pub/graphviz/ARCHIVE/graphviz-2.18-1.el4.i386.rpm 
    

See graphviz.org for details on what to put in the pom and for binaries for other distributions.

Resources

Apache Maven plugins
Mojo Codehaus
Sonar is an open source enterprise quality control tool. Collects metrics from multiple Maven projects.