View RSS Feed

My Java Tips

Documenting projects

Rate this Entry
by , 11-05-2011 at 06:58 PM (654 Views)
Everyone know how important it is to document the project. I wont be shedding light on this. But the aim of this post is
to introduce how Maven can help you generate project documentation.




Maven can actually generate a website for your project. Use following command to generate documentation:
Run the site:generate goal for your project with this command:

maven site:generate

Maven will generate html documentation in the docs directory which it will create under target. Simply open the index.html
in your web browser and surf around. All the project information, Javadocs, unit-test information, source code cross referencing, a coding style check, metrics are part of documentation.

Maven uses XDoc plug-in to get the look and feel of the site. This plug-in is located in the maven/plugins/maven-xdoc-plugin-1.1/ directory. Interested in changing the look and feel? Change the CSS, images, and XML templates and enjoy the new look.

Submit "Documenting projects" to Facebook Submit "Documenting projects" to Digg Submit "Documenting projects" to del.icio.us Submit "Documenting projects" to StumbleUpon Submit "Documenting projects" to Google

Tags: None Add / Edit Tags
Categories
Maven

Comments