Skip to content

Commit

Permalink
[MJAVADOC-613] exclude skipped javadoc modules from aggregated javadoc
Browse files Browse the repository at this point in the history
Signed-off-by: olivier lamy <olamy@apache.org>
  • Loading branch information
olamy committed Feb 8, 2020
1 parent 82d1f94 commit f07255a
Show file tree
Hide file tree
Showing 42 changed files with 544 additions and 1,578 deletions.
6 changes: 5 additions & 1 deletion pom.xml
Expand Up @@ -72,6 +72,7 @@ under the License.
<doxia-sitetoolsVersion>1.7.4</doxia-sitetoolsVersion>
<wagonVersion>2.4</wagonVersion>
<sonatypeAetherVersion>1.13.1</sonatypeAetherVersion>
<plexus-java.version>1.0.3</plexus-java.version>
<!-- for ITs -->
<sitePluginVersion>3.3</sitePluginVersion>
<projectInfoReportsPluginVersion>2.7</projectInfoReportsPluginVersion>
Expand Down Expand Up @@ -274,7 +275,7 @@ under the License.
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-java</artifactId>
<version>1.0.3</version>
<version>${plexus-java.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.plexus</groupId>
Expand Down Expand Up @@ -429,6 +430,9 @@ under the License.
<maven.home>${maven.home}</maven.home>
<https.protocols>${https.protocols}</https.protocols>
</systemPropertyVariables>
<environmentVariables>
<JENKINS_MAVEN_AGENT_DISABLED>true</JENKINS_MAVEN_AGENT_DISABLED>
</environmentVariables>
</configuration>
</plugin>
<plugin>
Expand Down
80 changes: 0 additions & 80 deletions src/it/projects/MJAVADOC-320/verify.bsh

This file was deleted.

48 changes: 48 additions & 0 deletions src/it/projects/MJAVADOC-320/verify.groovy
@@ -0,0 +1,48 @@

/*
* 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.
*/

File target = new File( basedir, "module2/target" );
assert target.exists()
assert target.isDirectory()

File apidocs = new File( target, "apidocs" );
assert apidocs.exists()
assert apidocs.isDirectory()

// module3 must be included
File module3File = new File( apidocs, "org/apache/maven/plugin/javadoc/it/Module3Class.html" );
assert module3File.exists()
assert module3File.isFile()

// el-api must be included
File elApiFile = new File( apidocs, "javax/el/ValueExpression.html" );
assert elApiFile.exists()
assert elApiFile.isFile()

// module1 must NOT be included
File module1File = new File( apidocs, "org/apache/maven/plugin/javadoc/it/Module1Class.html" );
assert !module1File.exists()
assert !module1File.isFile()

// servlet-api must NOT be included
File servletSpecFile = new File( apidocs, "javax/servlet/ServletContext.html" );
assert !servletSpecFile.exists()
assert !servletSpecFile.isFile()

33 changes: 33 additions & 0 deletions src/it/projects/MJAVADOC-613-aggregate-exclude/b/c/d1/pom.xml
@@ -0,0 +1,33 @@
<?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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
<artifactId>mjavadoc613c</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>mjavadoc613d1</artifactId>

</project>
@@ -1,4 +1,4 @@
package fix.test;
package a.b.c.d;

/*
* Licensed to the Apache Software Foundation (ASF) under one
Expand All @@ -9,7 +9,7 @@
* "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
* 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
Expand All @@ -19,21 +19,7 @@
* under the License.
*/

import java.util.List;
import java.util.Map;

/**
* To add default class tags.
*/
public class SubClassWithJavadoc
extends ClassWithJavadoc
public class D1
{
// ----------------------------------------------------------------------
// Inheritance
// ----------------------------------------------------------------------

@Override
public void withGenericParameters( List<String> aList, Map<Map<String, List<String>>, List<String>> aMap )
{
}
}
}
33 changes: 33 additions & 0 deletions src/it/projects/MJAVADOC-613-aggregate-exclude/b/c/d2/pom.xml
@@ -0,0 +1,33 @@
<?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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
<artifactId>mjavadoc613c</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>mjavadoc613d2</artifactId>

</project>
@@ -1,4 +1,4 @@
package fix.test;
package a.b.c.d;

/*
* Licensed to the Apache Software Foundation (ASF) under one
Expand All @@ -9,7 +9,7 @@
* "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
* 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
Expand All @@ -19,25 +19,7 @@
* under the License.
*/

import java.util.List;
import java.util.Map;

/**
* To add default class tags.
*
* @author <a href="mailto:vsiveton@apache.org">vsiveton@apache.org</a>
* @version $Id: $
*/
public class SubClassWithJavadoc
extends ClassWithJavadoc
public class D2
{
// ----------------------------------------------------------------------
// Inheritance
// ----------------------------------------------------------------------

/** {@inheritDoc} */
@Override
public void withGenericParameters( List<String> aList, Map<Map<String, List<String>>, List<String>> aMap )
{
}
}
}
53 changes: 53 additions & 0 deletions src/it/projects/MJAVADOC-613-aggregate-exclude/b/c/pom.xml
@@ -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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
<artifactId>mjavadoc613b</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>mjavadoc613c</artifactId>
<packaging>pom</packaging>

<modules>
<module>d1</module>
<module>d2</module>
</modules>

<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>

</project>
33 changes: 33 additions & 0 deletions src/it/projects/MJAVADOC-613-aggregate-exclude/b/e/pom.xml
@@ -0,0 +1,33 @@
<?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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
<artifactId>mjavadoc613b</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>mjavadoc613e</artifactId>

</project>

0 comments on commit f07255a

Please sign in to comment.