You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2021/05/16 18:41:53 UTC
[maven-javadoc-plugin] 01/01: [MJAVADOC-584] excludePackageNames is
not working as documented anymore
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch MJAVADOC-584
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
commit 3a222b203e1805b6f08979a2cfe77a1b460e18fc
Author: rfscholte <rf...@apache.org>
AuthorDate: Sun May 16 20:41:36 2021 +0200
[MJAVADOC-584] excludePackageNames is not working as documented anymore
---
.../exclude-package-names/invoker.properties | 20 +++++++
.../examples/exclude-package-names/pom.xml | 69 ++++++++++++++++++++++
.../src/main/java/com/mycompany/myapp/Include.java | 29 +++++++++
.../java/com/mycompany/myapp/package1/Include.java | 29 +++++++++
.../myapp/package1/subpackage1/Exclude.java | 29 +++++++++
.../myapp/package1/subpackage2/Exclude.java | 29 +++++++++
.../myapp/package1/subpackage3/Exclude.java | 29 +++++++++
.../com/mycompany/myapp/package1/util/Exclude.java | 29 +++++++++
.../java/com/mycompany/myapp/package2/Exclude.java | 29 +++++++++
.../myapp/package2/subpackage4/Exclude.java | 29 +++++++++
.../myapp/package2/subpackage5/Exclude.java | 29 +++++++++
.../com/mycompany/myapp/package2/util/Exclude.java | 29 +++++++++
.../java/com/mycompany/myapp/package3/Include.java | 29 +++++++++
.../myapp/package3/subpackage6/Include.java | 29 +++++++++
.../subpackage6/subsubpackage1/Include.java | 29 +++++++++
.../subpackage6/subsubpackage2/Include.java | 29 +++++++++
.../myapp/package3/subpackage7/Include.java | 29 +++++++++
.../com/mycompany/myapp/package3/util/Exclude.java | 29 +++++++++
.../examples/exclude-package-names/verify.groovy | 23 ++++++++
src/site/apt/examples/exclude-package-names.apt.vm | 42 +------------
20 files changed, 577 insertions(+), 41 deletions(-)
diff --git a/src/it/projects/examples/exclude-package-names/invoker.properties b/src/it/projects/examples/exclude-package-names/invoker.properties
new file mode 100644
index 0000000..026438d
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/invoker.properties
@@ -0,0 +1,20 @@
+# 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.
+
+# this plugins expects tools.jar, hence Java 8 or before
+invoker.java.version=9-
+invoker.goals=javadoc:javadoc
diff --git a/src/it/projects/examples/exclude-package-names/pom.xml b/src/it/projects/examples/exclude-package-names/pom.xml
new file mode 100644
index 0000000..0648022
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/pom.xml
@@ -0,0 +1,69 @@
+<?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.javadoc.example</groupId>
+ <artifactId>exclude-package-names</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <maven.compiler.source>@maven.compiler.source@</maven.compiler.source>
+ <maven.compiler.target>@maven.compiler.target@</maven.compiler.target>
+ </properties>
+
+ <url>http://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html</url>
+
+ <build>
+ <plugins>
+ <!-- START SNIPPET: excludePackageNames -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>@project.version@</version>
+ <configuration>
+ <!--
+ Exclude packages:
+ com.mycompany.myapp.package1.subpackage1
+ com.mycompany.myapp.package1.subpackage2
+ com.mycompany.myapp.package1.subpackage3
+ com.mycompany.myapp.package1.util
+ com.mycompany.myapp.package2
+ com.mycompany.myapp.package2.subpackage4
+ com.mycompany.myapp.package2.subpackage5
+ com.mycompany.myapp.package2.util
+ com.mycompany.myapp.package3.util
+ BUT include the packages:
+ com.mycompany.myapp
+ com.mycompany.myapp.package1
+ com.mycompany.myapp.package3
+ com.mycompany.myapp.package3.subpackage6
+ com.mycompany.myapp.package3.subpackage6.subsubpackage1
+ com.mycompany.myapp.package3.subpackage6.subsubpackage2
+ com.mycompany.myapp.package3.subpackage7
+ -->
+ <excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:com.mycompany.myapp.package2.*:*.util</excludePackageNames>
+ </configuration>
+ </plugin>
+ <!-- END SNIPPET: excludePackageNames -->
+ </plugins>
+ </build>
+</project>
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/Include.java
new file mode 100644
index 0000000..61caf7c
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/Include.java
new file mode 100644
index 0000000..ba592a8
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package1;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage1/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage1/Exclude.java
new file mode 100644
index 0000000..b12c252
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage1/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package1.subpackage1;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage2/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage2/Exclude.java
new file mode 100644
index 0000000..bf8306a
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage2/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package1.subpackage2;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage3/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage3/Exclude.java
new file mode 100644
index 0000000..f8d54f8
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/subpackage3/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package1.subpackage3;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/util/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/util/Exclude.java
new file mode 100644
index 0000000..1e819db
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package1/util/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package1.util;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/Exclude.java
new file mode 100644
index 0000000..3e2a4cf
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package2;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/subpackage4/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/subpackage4/Exclude.java
new file mode 100644
index 0000000..f27631e
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/subpackage4/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package2.subpackage4;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/subpackage5/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/subpackage5/Exclude.java
new file mode 100644
index 0000000..23185c2
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/subpackage5/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package2.subpackage5;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/util/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/util/Exclude.java
new file mode 100644
index 0000000..7f04d69
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package2/util/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package2.util;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/Include.java
new file mode 100644
index 0000000..d6918b9
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package3;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/Include.java
new file mode 100644
index 0000000..2ac5e33
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.packge3.subpackage6;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/subsubpackage1/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/subsubpackage1/Include.java
new file mode 100644
index 0000000..baaf254
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/subsubpackage1/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package3.subpackage6.subsubpackage1;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/subsubpackage2/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/subsubpackage2/Include.java
new file mode 100644
index 0000000..cde9220
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage6/subsubpackage2/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package3.subpackage6.subsubpackage2;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage7/Include.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage7/Include.java
new file mode 100644
index 0000000..fad7e01
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/subpackage7/Include.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package3.subpackage7;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is an Include
+ *
+ * @since 3.3.0
+ */
+public interface Include
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/util/Exclude.java b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/util/Exclude.java
new file mode 100644
index 0000000..1fb09d0
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/src/main/java/com/mycompany/myapp/package3/util/Exclude.java
@@ -0,0 +1,29 @@
+package com.mycompany.myapp.package3.util;
+
+/*
+ * 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.
+ */
+
+/**
+ * This is a Exclude.
+ *
+ * @since 3.3.0
+ */
+public interface Exclude
+{
+}
diff --git a/src/it/projects/examples/exclude-package-names/verify.groovy b/src/it/projects/examples/exclude-package-names/verify.groovy
new file mode 100644
index 0000000..82d92ca
--- /dev/null
+++ b/src/it/projects/examples/exclude-package-names/verify.groovy
@@ -0,0 +1,23 @@
+/*
+ * 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 options = new File( basedir, 'target/site/apidocs/argfile' )
+
+assert options.readLines().size() == 7
+assert options.readLines().count{it.endsWith("Include.java'")} == 7
diff --git a/src/site/apt/examples/exclude-package-names.apt.vm b/src/site/apt/examples/exclude-package-names.apt.vm
index 8245e29..8793823 100644
--- a/src/site/apt/examples/exclude-package-names.apt.vm
+++ b/src/site/apt/examples/exclude-package-names.apt.vm
@@ -57,44 +57,4 @@ com.mycompany.myapp.package3.util
You could have 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>
- <!--
- Exclude packages:
- com.mycompany.myapp.package1.subpackage1
- com.mycompany.myapp.package1.subpackage2
- com.mycompany.myapp.package1.subpackage3
- com.mycompany.myapp.package1.util
- com.mycompany.myapp.package2
- com.mycompany.myapp.package2.subpackage4
- com.mycompany.myapp.package2.subpackage5
- com.mycompany.myapp.package2.util
- com.mycompany.myapp.package3.util
- BUT include the packages:
- com.mycompany.myapp
- com.mycompany.myapp.package1
- com.mycompany.myapp.package3
- com.mycompany.myapp.package3.subpackage6
- com.mycompany.myapp.package3.subpackage6.subsubpackage1
- com.mycompany.myapp.package3.subpackage6.subsubpackage2
- com.mycompany.myapp.package3.subpackage7
- -->
- <excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:*.util.*</excludePackageNames>
- ...
- </configuration>
- </plugin>
- ...
- </plugins>
- ...
- </reporting> (or <build>)
- ...
-</project>
-+-----+
+%{snippet|id=excludePackageNames|file=target/it/examples/exclude-package-names/pom.xml}