Author: michaelo
Date: Sat Dec 19 18:09:12 2015
New Revision: 1720965
URL: http://svn.apache.org/viewvc?rev=1720965&view=rev
Log:
[MJAVADOC-385] Fix documentation of <additionalDependencies> feature
Contributed by: Stephan Schroevers <stephan.schroev...@teampicnic.com>
This fixes #74.
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/invoker.properties
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/pom.xml
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/library/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/library/HelloWorld.java
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/library/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/pom.xml
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/verify.bsh
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/invoker.properties
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/pom.xml
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/library/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/library/HelloWorld.java
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/library/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/pom.xml
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/verify.bsh
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/additional-dependencies.apt.vm
Removed:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additionnal-dependencies/
maven/plugins/trunk/maven-javadoc-plugin/src/it/additionnal-dependencies-non-aggregate/
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/additionnal-dependencies.apt.vm
Modified:
maven/plugins/trunk/maven-javadoc-plugin/pom.xml
maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-javadoc-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/pom.xml?rev=1720965&r1=1720964&r2=1720965&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/pom.xml Sat Dec 19 18:09:12 2015
@@ -381,7 +381,7 @@ under the License.
<artifactId>maven-invoker-plugin</artifactId>
<configuration>
<pomIncludes>
- <pomInclude>additionnal-dependencies*/pom.xml</pomInclude>
+ <pomInclude>additional-dependencies*/pom.xml</pomInclude>
<pomInclude>MJAVADOC-110/pom.xml</pomInclude>
<pomInclude>MJAVADOC-126/pom.xml</pomInclude>
<pomInclude>MJAVADOC-137/pom.xml</pomInclude>
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/invoker.properties
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/invoker.properties?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/invoker.properties
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/invoker.properties
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+invoker.goals=clean site
+invoker.java.version = 1.6+
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/pom.xml?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/pom.xml
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/pom.xml
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.maven.plugins.maven-javadoc-plugin.it</groupId>
+ <artifactId>additional-dependencies-non-aggregate</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>module1</artifactId>
+ <name>module1</name>
+ <version>1.0-SNAPSHOT</version>
+
+ <dependencies>
+ <dependency>
+ <groupId>net.sf.ehcache</groupId>
+ <artifactId>ehcache-core</artifactId>
+ <version>2.4.2</version>
+ </dependency>
+ <dependency>
+ <groupId>org.dbunit</groupId>
+ <artifactId>dbunit</artifactId>
+ <version>2.2</version>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.2</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/library/HelloWorld.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/library/HelloWorld.java?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/library/HelloWorld.java
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/main/java/edu/jhu/library/HelloWorld.java
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,43 @@
+package edu.jhu.library;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import net.sf.ehcache.Cache;
+import net.sf.ehcache.CacheManager;
+import net.sf.ehcache.Element;
+import net.sf.ehcache.Status;
+import net.sf.ehcache.store.MemoryStoreEvictionPolicy;
+
+/**
+ * Created by IntelliJ IDEA.
+ * User: esm
+ * Date: May 17, 2008
+ * Time: 11:26:25 AM
+ * To change this template use File | Settings | File Templates.
+ */
+public class HelloWorld
+{
+ private CacheManager cacheManager = CacheManager.getInstance();
+
+ public String hello( String s )
+ {
+ return s;
+ }
+}
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,44 @@
+package edu.jhu.library;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import junit.framework.TestCase;
+import org.dbunit.database.IDatabaseConnection;
+
+/**
+ * Created by IntelliJ IDEA.
+ * User: esm
+ * Date: May 17, 2008
+ * Time: 11:28:04 AM
+ * To change this template use File | Settings | File Templates.
+ */
+public class Mjavadoc180Test
+ extends TestCase
+{
+ /**
+ * This is some test javadoc. This test method has a phony dependency on
DB Unit.
+ */
+ public void testMJAVADOC180()
+ {
+ IDatabaseConnection phony = null;
+ final HelloWorld hw = new HelloWorld();
+ assertTrue( "Hello World".equals( hw.hello( "Hello World" ) ) );
+ }
+}
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/pom.xml?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/pom.xml
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/pom.xml
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,128 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.apache.maven.plugins.maven-javadoc-plugin.it</groupId>
+ <artifactId>additional-dependencies-non-aggregate</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <packaging>pom</packaging>
+
+ <name>MJAVADOC-180</name>
+
+ <modules>
+ <module>module1</module>
+ </modules>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>2.3.2</version>
+ <configuration>
+ <source>1.5</source>
+ <target>1.5</target>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>@sitePluginVersion@</version>
+ </plugin>
+ </plugins>
+ </build>
+
+ <!--
+ <dependencies>
+ <dependency>
+ <groupId>geronimo-spec</groupId>
+ <artifactId>geronimo-spec-jta</artifactId>
+ <version>1.0.1B-rc4</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+ -->
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>@projectInfoReportsPluginVersion@</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>index</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>@pom.version@</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ <configuration>
+ <docletArtifact>
+ <groupId>com.google.doclava</groupId>
+ <artifactId>doclava</artifactId>
+ <version>1.0.3</version>
+ </docletArtifact>
+ <doclet>com.google.doclava.Doclava</doclet>
+ <docletPath>/</docletPath>
+ <!--
+ | bootclasspath required by Sun's JVM
+ -->
+ <bootclasspath>${sun.boot.class.path}</bootclasspath>
+ <additionalparam>
+ <!-- comment as produce an NPE
+ -federate JDK http://docs.oracle.com/javase/6/docs/api/index.html?
+ -federationxml JDK
http://doclava.googlecode.com/svn/static/api/openjdk-6.xml -->
+ -hdf project.name "${project.name}"
+ -d ${project.build.directory}/site/apidocs
+ </additionalparam>
+ <useStandardDocletOptions>false</useStandardDocletOptions>
+ <!--
+ | Apple's JVM sometimes requires more memory
+ -->
+ <additionalJOption>-J-Xmx1024m</additionalJOption>
+ <additionalDependencies>
+ <additionalDependency>
+ <groupId>geronimo-spec</groupId>
+ <artifactId>geronimo-spec-jta</artifactId>
+ <version>1.0.1B-rc4</version>
+ </additionalDependency>
+ </additionalDependencies>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+</project>
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/verify.bsh
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/verify.bsh?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/verify.bsh
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies-non-aggregate/verify.bsh
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,68 @@
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.io.*;
+
+boolean result = true;
+
+try
+{
+ File target = new File( basedir, "module1/target" );
+ if ( !target.exists() || !target.isDirectory() )
+ {
+ System.err.println( "module1/target file is missing or a directory." );
+ return false;
+ }
+
+ File apidocs = new File( basedir, "module1/target/site/apidocs" );
+ if ( !apidocs.exists() || !apidocs.isDirectory() )
+ {
+ System.err.println( "module1/target/site/apidocs file is missing or a
directory." );
+ return false;
+ }
+
+ File options = new File( apidocs, "options" );
+ if ( !options.exists() || !options.isFile() )
+ {
+ System.err.println( "module1/target/site/apidocs/options file is
missing or not a file." );
+ return false;
+ }
+
+ File index = new File( apidocs, "index.html" );
+ if ( !index.exists() || !index.isFile() )
+ {
+ System.err.println( "module1/target/site/apidocs/index.html file is
missing or not a file." );
+ return false;
+ }
+
+ File reference = new File( apidocs, "reference" );
+ if ( !reference.exists() || reference.isFile() )
+ {
+ System.err.println( "module1/target/site/apidocs/reference file is
missing or a file." );
+ return false;
+ }
+}
+catch( IOException e )
+{
+ e.printStackTrace();
+ result = false;
+}
+
+return result;
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/invoker.properties
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/invoker.properties?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/invoker.properties
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/invoker.properties
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+invoker.goals=clean site
+invoker.java.version = 1.6+
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/pom.xml?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/pom.xml
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/pom.xml
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,59 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.maven.plugins.maven-javadoc-plugin.it</groupId>
+ <artifactId>additional-dependencies</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>module1</artifactId>
+ <name>module1</name>
+ <version>1.0-SNAPSHOT</version>
+
+ <dependencies>
+ <dependency>
+ <groupId>net.sf.ehcache</groupId>
+ <artifactId>ehcache-core</artifactId>
+ <version>2.4.2</version>
+ <exclusions>
+ <exclusion>
+ <groupId>commons-logging</groupId>
+ <artifactId>commons-logging</artifactId>
+ </exclusion>
+ </exclusions>
+ </dependency>
+ <dependency>
+ <groupId>org.dbunit</groupId>
+ <artifactId>dbunit</artifactId>
+ <version>2.2</version>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.2</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/library/HelloWorld.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/library/HelloWorld.java?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/library/HelloWorld.java
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/main/java/edu/jhu/library/HelloWorld.java
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,43 @@
+package edu.jhu.library;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import net.sf.ehcache.Cache;
+import net.sf.ehcache.CacheManager;
+import net.sf.ehcache.Element;
+import net.sf.ehcache.Status;
+import net.sf.ehcache.store.MemoryStoreEvictionPolicy;
+
+/**
+ * Created by IntelliJ IDEA.
+ * User: esm
+ * Date: May 17, 2008
+ * Time: 11:26:25 AM
+ * To change this template use File | Settings | File Templates.
+ */
+public class HelloWorld
+{
+ private CacheManager cacheManager = CacheManager.getInstance();
+
+ public String hello( String s )
+ {
+ return s;
+ }
+}
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/module1/src/test/java/edu/jhu/library/Mjavadoc180Test.java
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,44 @@
+package edu.jhu.library;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import junit.framework.TestCase;
+import org.dbunit.database.IDatabaseConnection;
+
+/**
+ * Created by IntelliJ IDEA.
+ * User: esm
+ * Date: May 17, 2008
+ * Time: 11:28:04 AM
+ * To change this template use File | Settings | File Templates.
+ */
+public class Mjavadoc180Test
+ extends TestCase
+{
+ /**
+ * This is some test javadoc. This test method has a phony dependency on
DB Unit.
+ */
+ public void testMJAVADOC180()
+ {
+ IDatabaseConnection phony = null;
+ final HelloWorld hw = new HelloWorld();
+ assertTrue( "Hello World".equals( hw.hello( "Hello World" ) ) );
+ }
+}
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/pom.xml?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/pom.xml
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/pom.xml
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,130 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.apache.maven.plugins.maven-javadoc-plugin.it</groupId>
+ <artifactId>additional-dependencies</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <packaging>pom</packaging>
+
+ <name>MJAVADOC-180</name>
+
+ <modules>
+ <module>module1</module>
+ </modules>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>2.3.2</version>
+ <configuration>
+ <source>1.5</source>
+ <target>1.5</target>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>@sitePluginVersion@</version>
+ </plugin>
+ </plugins>
+ </build>
+
+ <!--
+ <dependencies>
+ <dependency>
+ <groupId>geronimo-spec</groupId>
+ <artifactId>geronimo-spec-jta</artifactId>
+ <version>1.0.1B-rc4</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+ -->
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>@projectInfoReportsPluginVersion@</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>index</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>@pom.version@</version>
+ <inherited>true</inherited>
+ <configuration>
+ <debug>true</debug>
+ <quiet>false</quiet>
+ <verbose>true</verbose>
+ <aggregate>true</aggregate>
+ <links>
+ <link>http://java.sun.com/j2se/1.5.0/docs/api/</link>
+ </links>
+
+ <docletArtifact>
+ <groupId>com.google.doclava</groupId>
+ <artifactId>doclava</artifactId>
+ <version>1.0.3</version>
+ </docletArtifact>
+ <doclet>com.google.doclava.Doclava</doclet>
+ <docletPath>/</docletPath>
+ <!--
+ | bootclasspath required by Sun's JVM
+ -->
+ <bootclasspath>${sun.boot.class.path}</bootclasspath>
+ <additionalparam>
+ <!-- comment as produce an NPE
+ -federate JDK http://docs.oracle.com/javase/6/docs/api/index.html?
+ -federationxml JDK
http://doclava.googlecode.com/svn/static/api/openjdk-6.xml -->
+ -hdf project.name "${project.name}"
+ -d ${project.build.directory}/site/apidocs
+ </additionalparam>
+ <useStandardDocletOptions>false</useStandardDocletOptions>
+ <!--
+ | Apple's JVM sometimes requires more memory
+ -->
+ <additionalJOption>-J-Xmx1024m</additionalJOption>
+ <additionalDependencies>
+ <additionalDependency>
+ <groupId>geronimo-spec</groupId>
+ <artifactId>geronimo-spec-jta</artifactId>
+ <version>1.0.1B-rc4</version>
+ </additionalDependency>
+ </additionalDependencies>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+</project>
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/verify.bsh
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/verify.bsh?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/verify.bsh
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/it/additional-dependencies/verify.bsh
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,68 @@
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.io.*;
+
+boolean result = true;
+
+try
+{
+ File target = new File( basedir, "target" );
+ if ( !target.exists() || !target.isDirectory() )
+ {
+ System.err.println( "target file is missing or a directory." );
+ return false;
+ }
+
+ File apidocs = new File( basedir, "target/site/apidocs" );
+ if ( !apidocs.exists() || !apidocs.isDirectory() )
+ {
+ System.err.println( "target/site/apidocs file is missing or a
directory." );
+ return false;
+ }
+
+ File options = new File( apidocs, "options" );
+ if ( !options.exists() || !options.isFile() )
+ {
+ System.err.println( "target/site/apidocs/options file is missing or
not a file." );
+ return false;
+ }
+
+ File index = new File( apidocs, "index.html" );
+ if ( !index.exists() || !index.isFile() )
+ {
+ System.err.println( "target/site/apidocs/index.html file is missing or
not a file." );
+ return false;
+ }
+
+ File reference = new File( apidocs, "reference" );
+ if ( !reference.exists() || reference.isFile() )
+ {
+ System.err.println( "target/site/apidocs/reference file is missing or
a file." );
+ return false;
+ }
+}
+catch( IOException e )
+{
+ e.printStackTrace();
+ result = false;
+}
+
+return result;
Added:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/additional-dependencies.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/additional-dependencies.apt.vm?rev=1720965&view=auto
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/additional-dependencies.apt.vm
(added)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/additional-dependencies.apt.vm
Sat Dec 19 18:09:12 2015
@@ -0,0 +1,61 @@
+ ------
+ Add additional dependencies to javadoc classpath
+ ------
+ Olivier Lamy
+ ------
+ 2009-09-12
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Configuring additional dependencies
+
+ You can some additional dependencies to the javadoc classpath.
+
+ For instance, with the following configuration:
+
++-----+
+<project>
+ ...
+ <reporting> (or <build>)
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ ...
+ <additionalDependencies>
+ <additionalDependency>
+ <groupId>geronimo-spec</groupId>
+ <artifactId>geronimo-spec-jta</artifactId>
+ <version>1.0.1B-rc4</version>
+ </additionalDependency>
+ </additionalDependencies>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </reporting> (or </build>)
+ ...
+</project>
++-----+
\ No newline at end of file
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml?rev=1720965&r1=1720964&r2=1720965&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/site.xml Sat Dec 19
18:09:12 2015
@@ -53,7 +53,7 @@ under the License.
<item name="Generating Test Javadocs"
href="/examples/test-javadocs.html"/>
<item name="Selective Javadocs Reports"
href="/examples/selective-javadocs-report.html"/>
<item name="Fixing Javadoc Comments" href="/examples/fix-javadocs.html"/>
- <item name="Adding additionnal dependencies"
href="/examples/additionnal-dependencies.html"/>
+ <item name="Adding additional dependencies"
href="/examples/additional-dependencies.html"/>
<item name="Generate Javadoc without duplicate execution of phase
generate-sources" href="/examples/javadoc-nofork.html"/>
</menu>
</body>
