src/site/apt/examples/exclude-package-names.apt.vm

 ------
 Excluding Packages
 ------
 Maria Odea Ching
 ------
 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

Excluding Packages

 To exclude specific packages, use {{{../javadoc-mojo.html#excludePackageNames}\<excludePackageNames/\>}} parameter
 as shown below. The parameter accepts wildcard (*) characters in its value but the wildcards should either be at the
 start or the end of the package name. If more than one package is to be excluded, each package name must be separated
 either with a colon (':'), a comma (',') or a semicolon (';'). (similar to the
 {{{http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#exclude}Javadoc Tool}})

 For instance, with the following packages:

+-----+
com.mycompany.myapp
com.mycompany.myapp.package1
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
com.mycompany.myapp.package3.subpackage6
com.mycompany.myapp.package3.subpackage6.subsubpackage1
com.mycompany.myapp.package3.subpackage6.subsubpackage2
com.mycompany.myapp.package3.subpackage7
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>
+-----+