Author: mriou
Date: Wed Sep 6 11:21:01 2006
New Revision: 440820
URL: http://svn.apache.org/viewvc?view=rev&rev=440820
Log:
Javadoc generation. Made a small script to aggregate the javadoc generated by
each module into a single directory (with its index).
Added:
incubator/ode/trunk/assemble_jdoc.rb
Removed:
incubator/ode/trunk/bpel-api/src/main/java/org/apache/ode/bpel/iapi/package.html
Modified:
incubator/ode/trunk/pom.xml
Added: incubator/ode/trunk/assemble_jdoc.rb
URL:
http://svn.apache.org/viewvc/incubator/ode/trunk/assemble_jdoc.rb?view=auto&rev=440820
==============================================================================
--- incubator/ode/trunk/assemble_jdoc.rb (added)
+++ incubator/ode/trunk/assemble_jdoc.rb Wed Sep 6 11:21:01 2006
@@ -0,0 +1,36 @@
+#!/bin/ruby
+# Builds a new directory structure and a nice index that brings
+# together all the different javadocs generated for each module.
+# The output is generated in a javadoc_site directory.
+
+require 'fileutils'
+
+TARGET = 'javadoc_site'
+FileUtils.rm_r(TARGET) if (File.exist?(TARGET))
+FileUtils.mkdir(TARGET)
+
+index = <<BLOCK
+<html>
+ <body>
+ <!-- If a good soul feels like adding a CSS someday. -->
+ <div class='content' style='margin-right:10px;'>
+ <h2>Ode's Complete Javadoc</h2>
+ <p><ul>
+BLOCK
+
+Dir.new('.').each do |dir|
+ next if ['..', '.', '.svn'].include?(dir) || !File.directory?(dir)
+ next unless (File.exist?(source = "#{dir}/target/site/apidocs/."))
+ FileUtils.mkdir(dest = TARGET + '/' + dir)
+ FileUtils.cp_r(source, dest)
+ index << "\r\n<li>Module <a href='#{dir}/index.html'>#{dir}</a> (sources
available <a
href='http://svn.apache.org/repos/asf/incubator/ode/trunk/#{dir}'>here</a>)</li>"
+end
+
+index << <<BLOCK
+ </ul></p>
+ </div>
+ </body>
+</html>
+BLOCK
+
+File.new(TARGET + '/index.html', 'w').write(index)
\ No newline at end of file
Modified: incubator/ode/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/incubator/ode/trunk/pom.xml?view=diff&rev=440820&r1=440819&r2=440820
==============================================================================
--- incubator/ode/trunk/pom.xml (original)
+++ incubator/ode/trunk/pom.xml Wed Sep 6 11:21:01 2006
@@ -4,21 +4,21 @@
<artifactId>ode</artifactId>
<name>ODE</name>
- <packaging>pom</packaging>
- <modelVersion>4.0.0</modelVersion>
- <version>2.0-SNAPSHOT</version>
- <url>http://incubator.apache.org/ode</url>
- <issueManagement>
- <system>jira</system>
- <url>http://issues.apache.org</url>
- </issueManagement>
- <licenses>
- <license>
- <name>Apache Public License 2.0</name>
- <url>http://www.apache.org/licenses/LICENSE-2.0</url>
- <distribution>repo</distribution>
- </license>
- </licenses>
+ <packaging>pom</packaging>
+ <modelVersion>4.0.0</modelVersion>
+ <version>2.0-SNAPSHOT</version>
+ <url>http://incubator.apache.org/ode</url>
+ <issueManagement>
+ <system>jira</system>
+ <url>http://issues.apache.org</url>
+ </issueManagement>
+ <licenses>
+ <license>
+ <name>Apache Public License 2.0</name>
+ <url>http://www.apache.org/licenses/LICENSE-2.0</url>
+ <distribution>repo</distribution>
+ </license>
+ </licenses>
<scm>
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/ode/</connection>
@@ -35,9 +35,9 @@
<properties>
<!--maven.test.skip>true</maven.test.skip-->
<vendor.name>Apache Software Foundation</vendor.name>
- <!--
- Default ODE properties, these properties may be referenced in
resources and the
- like. -->
+ <!--
+ Default ODE properties, these properties may be referenced in
resources and the
+ like. -->
<ode.default.http.port>8080</ode.default.http.port>
<ode.default.rmi.port>2099</ode.default.rmi.port>
@@ -46,12 +46,12 @@
<ode.default.jmx.password>admin</ode.default.jmx.password>
<ode.default.domain>MyDomain</ode.default.domain>
- <!--
- |
- | Versions of external dependencies used in build
- | and execution.
- |
- -->
+ <!--
+ |
+ | Versions of external dependencies used in build
+ | and execution.
+ |
+ -->
<activationVersion>1.1</activationVersion>
<antVersion>1.6.5</antVersion>
<axisVersion>1.3</axisVersion>
@@ -82,27 +82,27 @@
<xmlbeansVersion>2.1.0</xmlbeansVersion>
<springVersion>1.2.6</springVersion>
<derbyVersion>10.1.2.1</derbyVersion>
- <quartzVersion>1.5.1</quartzVersion>
-
- <!--
- | Build number used by the intalio:release plugin
- -->
- <release.buildnumber>1000</release.buildnumber>
+ <quartzVersion>1.5.1</quartzVersion>
+
+ <!--
+ | Build number used by the intalio:release plugin
+ -->
+ <release.buildnumber>1000</release.buildnumber>
</properties>
- <!--|
- | List of ODE modules to build
- |
- -->
+ <!--|
+ | List of ODE modules to build
+ |
+ -->
<modules>
<module>jbi-examples</module>
<module>tools-bin</module>
<module>axis2</module>
<module>axis2-war</module>
- <module>axis2-examples</module>
+ <module>axis2-examples</module>
<module>bootstrap</module>
<module>utils</module>
@@ -154,10 +154,10 @@
</dependency>
</dependencies>
- <!-- |
- | Setup plugins used by the modules.
- |
- -->
+ <!-- |
+ | Setup plugins used by the modules.
+ |
+ -->
<build>
<defaultGoal>package</defaultGoal>
<extensions>
@@ -172,11 +172,11 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
- <!-- Alex: Use specific version for release -->
- <!--version>2.1-SNAPSHOT</version-->
+ <!-- Alex: Use specific version for release -->
+ <!--version>2.1-SNAPSHOT</version-->
<version>2.1.20060107.015454.4</version>
</plugin>
-
+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
@@ -185,17 +185,17 @@
<target>1.5</target>
</configuration>
</plugin>
- <!--|
- | This version uses xjavadoc-1.1-j5, which doesn't
- | complain on Java 5.0 constructs.
- |
- -->
+ <!--|
+ | This version uses xjavadoc-1.1-j5, which doesn't
+ | complain on Java 5.0 constructs.
+ |
+ -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xdoclet-maven-plugin</artifactId>
<version>1.0-alpha-2-j5</version>
</plugin>
- <!--|
+ <!--|
| This version removes dependency on JSR173,
| which is not available in public repositories.
|
@@ -220,6 +220,16 @@
<remoteRepositoryUrl>scpexe://ode.intalio.org/var/www/public/maven1</remoteRepositoryUrl>
</configuration>
</plugin>
+ <!-- Allows direct usage of the javadoc:javadoc goal. -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.0</version>
+ <configuration>
+ <minmemory>128m</minmemory>
+ <maxmemory>512</maxmemory>
+ </configuration>
+ </plugin>
</plugins>
</pluginManagement>
</build>
@@ -257,7 +267,7 @@
<id>ode</id>
<name>Apache Ode Repository</name>
<url>http://incubator.apache.org/ode/m2</url>
- <layout>legacy</layout>
+ <layout>legacy</layout>
</repository>
<repository>
<id>jibx</id>
@@ -304,13 +314,13 @@
<dependencyManagement>
<dependencies>
-
+
<dependency>
<groupId>ode</groupId>
<artifactId>ode-bpel-bom</artifactId>
<version>${project.version}</version>
</dependency>
-
+
<dependency>
<groupId>ode</groupId>
<artifactId>ode-bootstrap</artifactId>
@@ -499,10 +509,10 @@
<version>${axisVersion}</version>
</dependency>
<dependency>
- <groupId>quartz</groupId>
- <artifactId>quartz</artifactId>
- <version>${quartzVersion}</version>
- </dependency>
+ <groupId>quartz</groupId>
+ <artifactId>quartz</artifactId>
+ <version>${quartzVersion}</version>
+ </dependency>
<dependency>
<groupId>javax.activation</groupId>
@@ -554,12 +564,12 @@
<artifactId>commons-pool</artifactId>
<version>${commonsPoolVersion}</version>
<exclusions>
- <!-- These need to be excluded, we are on JDK5 -->
+ <!-- These need to be excluded, we are on JDK5 -->
<exclusion>
<artifactId>xerces</artifactId>
<groupId>xerces</groupId>
</exclusion>
-
+
<exclusion>
<artifactId>xml-apis</artifactId>
<groupId>xml-apis</groupId>
@@ -602,11 +612,11 @@
<version>${jaxenVersion}</version>
</dependency>
- <!--
- | Jetty is used for the standalone-distro. The
- | JASPER modules are actually required by Jetty
- | but the transitive dependencies are not present.
- -->
+ <!--
+ | Jetty is used for the standalone-distro. The
+ | JASPER modules are actually required by Jetty
+ | but the transitive dependencies are not present.
+ -->
<dependency>
<groupId>jetty</groupId>
