Wednesday, November 17, 2010

Better Javadocs in Maven

Over the summer, I worked with Google's Android team on a project called Doclava. Doclava is a tool that generates modern javadocs for your project, including a refreshed look-and-feel, javascript-based search that works both on- and off-line, and federated documentation, so your project can link against others. For example, a method print(String theString) would have the "String" class link to the relevant documentation in the JDK.

Last week, we got Doclava added to the Maven repository. Now, Maven users can add support for Doclava by simply copying a few lines of configuration into the pom.xml file!

To check it out for yourself, see the Getting Started guide.