link
Avalon
Avalon Central
Home PlanetProductsCentral
Javadoc Task

The javadoc task provides support for automatic generation of consolidated javadoc taking into account the source directories of dependent projects. If the target of javadoc generation supports staged classloader defintions (API, SPI, IMPL) - then javadoc will be generated for each set. The task supports local and remote link declarations (see source for additional details).

The following declarations instruct the current build to invoke javadoc generation on an identified project using the id attribute. The title attribute sets the javadoc title.

<x:javadoc title="Merlin Runtime" id="avalon-runtime">
  <x:link href="http://java.sun.com/j2se/1.4/docs/api" />
</x:javadoc>

Typical output of the javadoc task:

javadoc:
[x:javadoc] Generating: Merlin Runtime, Version 3.3.0 : API
[x:javadoc] link: http://java.sun.com/j2se/1.4/docs/api
[x:javadoc] Adding src path: F:\dev\avalon\runtime\framework\api\target\build\main
[x:javadoc] Adding src path: F:\dev\avalon\runtime\util\lifecycle\target\build\main
  [javadoc] Generating Javadoc
  [javadoc] Javadoc execution
  [javadoc] Loading source files for package org.apache.avalon.framework...
  [javadoc] Loading source files for package org.apache.avalon.framework.activity...
  [javadoc] Loading source files for package org.apache.avalon.framework.configuration...
  [javadoc] Loading source files for package org.apache.avalon.framework.context...
  [javadoc] Loading source files for package org.apache.avalon.framework.logger...
  [javadoc] Loading source files for package org.apache.avalon.framework.parameters...
  [javadoc] Loading source files for package org.apache.avalon.framework.service...
  [javadoc] Loading source files for package org.apache.avalon.framework.thread...
  [javadoc] Loading source files for package org.apache.avalon.lifecycle...
  [javadoc] Constructing Javadoc information...
  [javadoc] Standard Doclet version 1.4.2_04
  [javadoc] Building tree for all the packages and classes...
  [javadoc] Building index for all the packages and classes...
  [javadoc] Building index for all classes...

  [javadoc] Generating F:\dev\avalon\central\system\.docs\avalon\runtime\3.3.0\api\stylesheet.css...

  ....