javadoc build infrastructure in place; mvn site will aggregate all javadoc under ${basedir}/target/site/apidocs. note that this is not (yet) in line with the s2 'green' l&f for javadoc; that will come later.

This commit is contained in:
Chris Beams
2010-05-20 17:49:39 +00:00
parent 1df136848e
commit cf6027e3b7
3 changed files with 117 additions and 47 deletions

93
pom.xml
View File

@@ -161,19 +161,6 @@
<target>1.5</target>
</configuration>
</plugin>
<!--
<plugin> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.0.2</version> <configuration> <source>1.5</source>
<target>1.5</target> <compilerVersion>1.6</compilerVersion>
<fork>true</fork> <executable>java -jar
"${env.M2_REPO_C}/org/eclipse/jdt/core/${org.eclipse.jdt.core.version}/core-${org.eclipse.jdt.core.version}.jar"
-classpath rt.jar -sourcepath "src/main"</executable>
</configuration> <dependencies> <dependency>
<groupId>org.eclipse.jdt</groupId> <artifactId>core</artifactId>
<version>${org.eclipse.jdt.core.version}</version> </dependency>
</dependencies> </plugin>
-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
@@ -192,7 +179,7 @@
<plugin>
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId>
<version>2.0.9</version>
<version>2.0.6</version>
<executions>
<execution>
<goals>
@@ -292,43 +279,64 @@
</plugins>
</pluginManagement>
</build>
<reporting>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<configuration>
<javadoc:aggregate>true</javadoc:aggregate>
<breakiterator>true</breakiterator>
<header>Spring Integration</header>
<source>1.5</source>
<quiet>true</quiet>
<!-- TODO: update stylesheet to s2 green L&F -->
<stylesheetfile>${basedir}/src/main/javadoc/javadoc.css</stylesheetfile>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<groups>
<group>
<title>Spring Integration</title>
<packages>org.springframework.integration.core</packages>
</group>
<!-- TODO: fill in other groups -->
</groups>
<javadocDirectory>${basedir}/src/main/javadoc</javadocDirectory>
<excludePackageNames>org.springframework.integration.samples</excludePackageNames>
<links>
<!-- TODO: examine JavaDoc warnings and see what other api links are needed -->
<link>http://static.springframework.org/spring/docs/${org.springframework.version}/javadoc-api</link>
<link>http://java.sun.com/javase/6/docs/api</link>
</links>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
<repositories>
<repository>
<id>glassfish</id>
<name> Glassfish Repository </name>
<name>Glassfish Repository</name>
<url>http://download.java.net/maven/glassfish</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
<snapshots><enabled>false</enabled></snapshots>
</repository>
<repository>
<id>jboss</id>
<name>JBoss Repository</name>
<url>http://repository.jboss.org/maven2</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>com.springsource.repository.bundles.release</id>
<name>SpringSource Enterprise Bundle Repository - SpringSource Bundle Releases</name>
<url>http://repository.springsource.com/maven/bundles/release</url>
</repository>
<repository>
<id>com.springsource.repository.bundles.external</id>
<name>SpringSource Enterprise Bundle Repository - External Bundle Releases</name>
<url>http://repository.springsource.com/maven/bundles/external</url>
<releases><enabled>true</enabled></releases>
<snapshots><enabled>false</enabled></snapshots>
</repository>
<repository>
<id>objectstyle</id>
<name>ObjectStyle.org Repository</name>
<url>http://objectstyle.org/maven2/</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
<snapshots><enabled>false</enabled></snapshots>
</repository>
</repositories>
<pluginRepositories>
@@ -341,22 +349,13 @@
<id>com.springsource.repository.bundles.milestone</id>
<name>SpringSource Enterprise Bundle Repository - SpringSource Bundle Milestones</name>
<url>http://repository.springsource.com/maven/bundles/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
<snapshots><enabled>false</enabled></snapshots>
</pluginRepository>
<pluginRepository>
<id>com.springsource.repository.bundles.snapshot</id>
<name>SpringSource Enterprise Bundle Repository - SpringSource Bundle Snapshots</name>
<url>http://repository.springsource.com/maven/bundles/snapshot</url>
</pluginRepository>
<pluginRepository>
<id>agilejava</id>
<url>http://agilejava.com/maven</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<dependencies>
<!-- including log4j to quell respect src/test log4j.xml settings -->

View File

@@ -0,0 +1,48 @@
/* Spring-specific Javadoc style sheet rules */
#overviewBody {
}
.code {
border: 1px solid black;
background-color: #F4F4F4;
padding: 5px;
}
/* Vanilla Javadoc style sheet rules */
body {
font-family: Helvetica, Arial, sans-serif;
background-color: white;
font-size: 10pt;
}
td { font-size: 10pt; font-family: Helvetica, Arial, sans-serif }/* Javadoc style sheet */
/* Define colors, fonts and other style attributes here to override the defaults */
/* Page background color */
body { background-color: #FFFFFF }
/* Headings */
h1 { font-size: 145% }
/* Table colors */
.TableHeadingColor { background: #CCCCFF } /* Dark mauve */
.TableSubHeadingColor { background: #EEEEFF } /* Light mauve */
.TableRowColor { background: #FFFFFF } /* White */
/* Font used in left-hand frame lists */
.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif }
.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
/* Navigation bar fonts and colors */
.NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */
.NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */
.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}

View File

@@ -0,0 +1,23 @@
<html>
<body>
This document is the API specification for the Spring WS Framework
<hr/>
<div id="overviewBody">
<p>
For further API reference and developer documentation, see the
<a href="http://static.springframework.org/spring-ws/site/reference.html" target="_top">Spring
Web Services reference documentation</a>.
That documentation contains more detailed, developer-targeted
descriptions, with conceptual overviews, definitions of terms,
workarounds, and working code examples.
</p>
<p>
If you are interested in commercial training, consultancy, and
support for the Spring Web Services Framework,
<a href="http://www.springsource.com/" target="_top">SpringSource</a> provides
such commercial support.
</p>
</div>
</body>
</html>