Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

The latest Javadocs with links to source code Javadocs for various Taverna 2.x versions (starting with 2.2) can be found on the Taverna Web site.

In order to generate the Javadocs documentation, as of Taverna 2.2.0, we have created a module the taverna-javadocs in  module in the net.sf.taverna.t2.taverna-workbench under products product in SVN. It is currently under the maintenance branch as we have done it after the Taverna 2.2.0 release, but it will be merged into the trunk for the next Taverna release.

The module only contains one a single pom.xml file with instructions on how to generate javadocs Javadocs as part of the "release" build profile. This means that this profile will be activated at the time when we do a Taverna release with the normal mvn clean install command on the net.sf.taverna.t2.taverna-workbench product, and not while we do builds during the usual day-to-day development.

If you want to do a build of javadocs Javadocs set of documents yourself (and not part of the release) - check out the taverna-javadocs module and inside it do:

...

This will activate the release profile and build javadocs documents for you in the target/apidocs inside the module's directory.

Note

Make sure you use Java 1.6! You can tweak these settings in the pom.xml, but using Java 1.5.0_26 to generate the documentation is known to fail on MAC OS X Leopard 10.5.8.

Tip

inside the pom.xml the heap and gen space memory for the JVM are set to 1024MB each (so you do not have to do anything using MVN_OPTIONS environment variable):

Code Block
<additionalJOption>-J-Xmx1024m -J-XX:MaxPermSize=1024m</additionalJOption>

You can tweak those settings but beware that the generation of Javadocs will require loads of memory.