package org.apache.maven.plugin.javadoc;

 /*

  * 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 static org.codehaus.plexus.util.IOUtil.close;

 import static org.apache.maven.plugin.javadoc.JavadocUtil.toList;

 import static org.apache.maven.plugin.javadoc.JavadocUtil.toRelative;

 import static org.apache.maven.plugin.javadoc.JavadocUtil.isNotEmpty;

 import static org.apache.maven.plugin.javadoc.JavadocUtil.isEmpty;

 import java.io.File;

 import java.io.FileWriter;

 import java.io.IOException;

 import java.io.InputStream;

 import java.net.MalformedURLException;

 import java.net.URI;

 import java.net.URISyntaxException;

 import java.net.URL;

 import java.net.URLClassLoader;

 import java.util.ArrayList;

 import java.util.Arrays;

 import java.util.Calendar;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.HashMap;

 import java.util.HashSet;

 import java.util.Iterator;

 import java.util.LinkedHashSet;

 import java.util.LinkedList;

 import java.util.List;

 import java.util.Locale;

 import java.util.Map;

 import java.util.Properties;

 import java.util.Set;

 import java.util.StringTokenizer;

 import org.apache.commons.lang.ClassUtils;

 import org.apache.commons.lang.SystemUtils;

 import org.apache.maven.artifact.Artifact;

 import org.apache.maven.artifact.factory.ArtifactFactory;

 import org.apache.maven.artifact.handler.ArtifactHandler;

 import org.apache.maven.artifact.metadata.ArtifactMetadataSource;

 import org.apache.maven.artifact.repository.ArtifactRepository;

 import org.apache.maven.artifact.resolver.ArtifactNotFoundException;

 import org.apache.maven.artifact.resolver.ArtifactResolutionException;

 import org.apache.maven.artifact.resolver.ArtifactResolutionResult;

 import org.apache.maven.artifact.resolver.ArtifactResolver;

 import org.apache.maven.artifact.resolver.MultipleArtifactsNotFoundException;

 import org.apache.maven.artifact.resolver.filter.AndArtifactFilter;

 import org.apache.maven.artifact.versioning.ArtifactVersion;

 import org.apache.maven.artifact.versioning.DefaultArtifactVersion;

 import org.apache.maven.execution.MavenSession;

 import org.apache.maven.model.Dependency;

 import org.apache.maven.model.Plugin;

 import org.apache.maven.model.Resource;

 import org.apache.maven.plugin.AbstractMojo;

 import org.apache.maven.plugin.javadoc.options.BootclasspathArtifact;

 import org.apache.maven.plugin.javadoc.options.DocletArtifact;

 import org.apache.maven.plugin.javadoc.options.Group;

 import org.apache.maven.plugin.javadoc.options.JavadocOptions;

 import org.apache.maven.plugin.javadoc.options.JavadocPathArtifact;

 import org.apache.maven.plugin.javadoc.options.OfflineLink;

 import org.apache.maven.plugin.javadoc.options.ResourcesArtifact;

 import org.apache.maven.plugin.javadoc.options.Tag;

 import org.apache.maven.plugin.javadoc.options.Taglet;

 import org.apache.maven.plugin.javadoc.options.TagletArtifact;

 import org.apache.maven.plugin.javadoc.options.io.xpp3.JavadocOptionsXpp3Writer;

 import org.apache.maven.plugin.javadoc.resolver.JavadocBundle;

 import org.apache.maven.plugin.javadoc.resolver.ResourceResolver;

 import org.apache.maven.plugin.javadoc.resolver.SourceResolverConfig;

 import org.apache.maven.project.MavenProject;

 import org.apache.maven.project.MavenProjectBuilder;

 import org.apache.maven.project.ProjectBuildingException;

 import org.apache.maven.project.artifact.InvalidDependencyVersionException;

 import org.apache.maven.reporting.MavenReportException;

 import org.apache.maven.settings.Proxy;

 import org.apache.maven.settings.Settings;

 import org.apache.maven.shared.artifact.filter.PatternExcludesArtifactFilter;

 import org.apache.maven.shared.artifact.filter.PatternIncludesArtifactFilter;

 import org.apache.maven.shared.invoker.MavenInvocationException;

 import org.apache.maven.toolchain.Toolchain;

 import org.apache.maven.toolchain.ToolchainManager;

 import org.apache.maven.wagon.PathUtils;

 import org.codehaus.plexus.archiver.ArchiverException;

 import org.codehaus.plexus.archiver.UnArchiver;

 import org.codehaus.plexus.archiver.manager.ArchiverManager;

 import org.codehaus.plexus.archiver.manager.NoSuchArchiverException;

 import org.codehaus.plexus.components.io.fileselectors.IncludeExcludeFileSelector;

 import org.codehaus.plexus.util.FileUtils;

 import org.codehaus.plexus.util.IOUtil;

 import org.codehaus.plexus.util.ReaderFactory;

 import org.codehaus.plexus.util.StringUtils;

 import org.codehaus.plexus.util.cli.CommandLineException;

 import org.codehaus.plexus.util.cli.CommandLineUtils;

 import org.codehaus.plexus.util.cli.Commandline;

 import org.codehaus.plexus.util.xml.Xpp3Dom;

 /**

  * Base class with majority of Javadoc functionalities.

  *

  * @author <a href="mailto:brett@apache.org">Brett Porter</a>

  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>

  * @version $Id: org.apache.maven.plugin.javadoc.AbstractJavadocMojo.html 829396 2012-08-19 17:35:19Z hboutemy $

  * @since 2.0

  * @requiresDependencyResolution compile

  * @see <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html">

  * The Java API Documentation Generator, 1.4.2</a>

  */

 public abstract class AbstractJavadocMojo

     extends AbstractMojo

 {

     /**

      * Classifier used in the name of the javadoc-options XML file, and in the resources bundle 

      * artifact that gets attached to the project. This one is used for non-test javadocs.

      * 

      * @since 2.7

      * @see #TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER

      */

     public static final String JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER = "javadoc-resources";

     /**

      * Classifier used in the name of the javadoc-options XML file, and in the resources bundle 

      * artifact that gets attached to the project. This one is used for test-javadocs.

      * 

      * @since 2.7

      * @see #JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER

      */

     public static final String TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER = "test-javadoc-resources";

     /**

      * The default Javadoc API urls according the

      * <a href="http://java.sun.com/reference/api/index.html">Sun API Specifications</a>:

      * <pre>

      * <javaApiLinks>

      *   <property>

      *     <name>api_1.3</name>

      *     <value>http://java.sun.com/j2se/1.3/docs/api</value>

      *   </property>

      *   <property>

      *     <name>api_1.4</name>

      *     <value>http://java.sun.com/j2se/1.4.2/docs/api/</value>

      *   </property>

      *   <property>

      *     <name>api_1.5</name>

      *     <value>http://java.sun.com/j2se/1.5.0/docs/api/</value>

      *   </property>

      *   <property>

      *     <name>api_1.6</name>

      *     <value>http://java.sun.com/javase/6/docs/api/</value>

      *   </property>

      * </javaApiLinks>

      * </pre>

      *

      * @since 2.6

      */

     public static final Properties DEFAULT_JAVA_API_LINKS = new Properties();

     /** The Javadoc script file name when <code>debug</code> parameter is on, i.e. javadoc.bat or javadoc.sh */

     protected static final String DEBUG_JAVADOC_SCRIPT_NAME =

         "javadoc." + ( SystemUtils.IS_OS_WINDOWS ? "bat" : "sh" );

     /** The <code>options</code> file name in the output directory when calling:

      * <code>javadoc.exe(or .sh) &#x40;options &#x40;packages | &#x40;argfile | &#x40;files</code> */

     protected static final String OPTIONS_FILE_NAME = "options";

     /** The <code>packages</code> file name in the output directory when calling:

      * <code>javadoc.exe(or .sh) &#x40;options &#x40;packages | &#x40;argfile | &#x40;files</code> */

     protected static final String PACKAGES_FILE_NAME = "packages";

     /** The <code>argfile</code> file name in the output directory when calling:

      * <code>javadoc.exe(or .sh) &#x40;options &#x40;packages | &#x40;argfile | &#x40;files</code> */

     protected static final String ARGFILE_FILE_NAME = "argfile";

     /** The <code>files</code> file name in the output directory when calling:

      * <code>javadoc.exe(or .sh) &#x40;options &#x40;packages | &#x40;argfile | &#x40;files</code> */

     protected static final String FILES_FILE_NAME = "files";

     /** The current class directory */

     private static final String RESOURCE_DIR = ClassUtils.getPackageName( JavadocReport.class ).replace( '.', '/' );

     /** Default css file name */

     private static final String DEFAULT_CSS_NAME = "stylesheet.css";

     /** Default location for css */

     private static final String RESOURCE_CSS_DIR = RESOURCE_DIR + "/css";

     /**

      * For Javadoc options appears since Java 1.4.

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">

      * What's New in Javadoc 1.4</a>

      * @since 2.1

      */

     private static final float SINCE_JAVADOC_1_4 = 1.4f;

     /**

      * For Javadoc options appears since Java 1.4.2.

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions">

      * What's New in Javadoc 1.4.2</a>

      * @since 2.1

      */

     private static final float SINCE_JAVADOC_1_4_2 = 1.42f;

     /**

      * For Javadoc options appears since Java 5.0.

      * See <a href="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#commandlineoptions">

      * What's New in Javadoc 5.0</a>

      * @since 2.1

      */

     private static final float SINCE_JAVADOC_1_5 = 1.5f;

     /**

      * For Javadoc options appears since Java 6.0.

      * See <a href="http://java.sun.com/javase/6/docs/technotes/guides/javadoc/index.html">

      * Javadoc Technology</a>

      * @since 2.4

      */

     private static final float SINCE_JAVADOC_1_6 = 1.6f;

     // ----------------------------------------------------------------------

     // Mojo components

     // ----------------------------------------------------------------------

     /**

      * Archiver manager

      *

      * @since 2.5

      * @component

      */

     private ArchiverManager archiverManager;

     /**

      * Factory for creating artifact objects

      *

      * @component

      */

     private ArtifactFactory factory;

     /**

      * Used to resolve artifacts of aggregated modules

      *

      * @since 2.1

      * @component

      */

     private ArtifactMetadataSource artifactMetadataSource;

     /**

      * Used for resolving artifacts

      *

      * @component

      */

     private ArtifactResolver resolver;

     /**

      * Project builder

      *

      * @since 2.5

      * @component

      */

     private MavenProjectBuilder mavenProjectBuilder;

     /** @component */

     private ToolchainManager toolchainManager;

     // ----------------------------------------------------------------------

     // Mojo parameters

     // ----------------------------------------------------------------------

     /**

      * The current build session instance. This is used for

      * toolchain manager API calls.

      *

      * @parameter expression="${session}"

      * @required

      * @readonly

      */

     private MavenSession session;

     /**

      * The Maven Settings.

      *

      * @since 2.3

      * @parameter default-value="${settings}"

      * @required

      * @readonly

      */

     private Settings settings;

     /**

      * The Maven Project Object

      *

      * @parameter expression="${project}"

      * @required

      * @readonly

      */

     protected MavenProject project;

     /**

      * Specify if the Javadoc should operate in offline mode.

      *

      * @parameter default-value="${settings.offline}"

      * @required

      * @readonly

      */

     private boolean isOffline;

     /**

      * Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).

      * <br/>

      * Could be used in addition of <code>docfilessubdirs</code> parameter.

      * <br/>

      * See <a href="#docfilessubdirs">docfilessubdirs</a>.

      *

      * @since 2.1

      * @parameter expression="${basedir}/src/main/javadoc"

      * @see #docfilessubdirs

      */

     private File javadocDirectory;

     /**

      * Set an additional parameter(s) on the command line. This value should include quotes as necessary for

      * parameters that include spaces. Useful for a custom doclet.

      *

      * @parameter expression="${additionalparam}"

      */

     private String additionalparam;

     /**

      * Set an additional Javadoc option(s) (i.e. JVM options) on the command line.

      * Example:

      * <pre>

      * <additionalJOption>-J-Xss128m</additionalJOption>

      * </pre>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#J">Jflag</a>.

      * <br/>

      * See <a href="http://java.sun.com/javase/technologies/hotspot/vmoptions.jsp">vmoptions</a>.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html">Networking Properties</a>.

      *

      * @since 2.3

      * @parameter expression="${additionalJOption}"

      */

     private String additionalJOption;

     /**

      * A list of artifacts containing resources which should be copied into the

      * Javadoc output directory (like stylesheets, icons, etc.).

      * <br/>

      * Example:

      * <pre>

      * <resourcesArtifacts>

      *   <resourcesArtifact>

      *     <groupId>external.group.id</groupId>

      *     <artifactId>external-resources</artifactId>

      *     <version>1.0</version>

      *   </resourcesArtifact>

      * </resourcesArtifacts>

      * </pre>

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/ResourcesArtifact.html">Javadoc</a>.

      * <br/>

      *

      * @since 2.5

      * @parameter expression="${resourcesArtifacts}"

      */

     private ResourcesArtifact[] resourcesArtifacts;

     /**

      * The local repository where the artifacts are located.

      *

      * @parameter expression="${localRepository}"

      */

     private ArtifactRepository localRepository;

     /**

      * The remote repositories where artifacts are located.

      *

      * @parameter expression="${project.remoteArtifactRepositories}"

      */

     private List remoteRepositories;

     /**

      * The projects in the reactor for aggregation report.

      *

      * @parameter expression="${reactorProjects}"

      * @readonly

      */

     private List<MavenProject> reactorProjects;

     /**

      * Whether to build an aggregated report at the root, or build individual reports.

      *

      * @parameter expression="${aggregate}" default-value="false"

      * @deprecated since 2.5. Use the goals <code>javadoc:aggregate</code> and <code>javadoc:test-aggregate</code> instead.

      */

     protected boolean aggregate;

     /**

      * Set this to <code>true</code> to debug the Javadoc plugin. With this, <code>javadoc.bat(or.sh)</code>,

      * <code>options</code>, <code>@packages</code> or <code>argfile</code> files are provided in the output directory.

      * <br/>

      *

      * @since 2.1

      * @parameter expression="${debug}" default-value="false"

      */

     private boolean debug;

     /**

      * Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification

      * is sufficient to have the plugin use "javadoc" or "javadoc.exe" respectively from this directory.

      *

      * @since 2.3

      * @parameter expression="${javadocExecutable}"

      */

     private String javadocExecutable;

     /**

      * Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".

      *

      * @since 2.3

      * @parameter expression="${javadocVersion}"

      */

     private String javadocVersion;

     /**

      * Version of the Javadoc Tool executable to use as float.

      */

     private float fJavadocVersion = 0.0f;

     /**

      * Specifies whether the Javadoc generation should be skipped.

      *

      * @since 2.5

      * @parameter expression="${maven.javadoc.skip}" default-value="false"

      */

     protected boolean skip;

     /**

      * Specifies whether the build will continue even if there are errors.

      *

      * @parameter expression="${maven.javadoc.failOnError}" default-value="true"

      * @since 2.5

      */

     protected boolean failOnError;

     /**

      * Specifies to use the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#standard">

      * options provided by the Standard Doclet</a> for a custom doclet.

      * <br/>

      * Example:

      * <pre>

      * <docletArtifacts>

      *   <docletArtifact>

      *     <groupId>com.sun.tools.doclets</groupId>

      *     <artifactId>doccheck</artifactId>

      *     <version>1.2b2</version>

      *   </docletArtifact>

      * </docletArtifacts>

      * <useStandardDocletOptions>true</useStandardDocletOptions>

      * </pre>

      *

      * @parameter expression="${useStandardDocletOptions}" default-value="true"

      * @since 2.5

      */

     protected boolean useStandardDocletOptions;

     /**

      * Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default

      * Maven conventions, i.e.: <code>${project.url}/apidocs</code>.

      * <br/>

      * For instance, if the project has a dependency to

      * <a href="http://commons.apache.org/lang/">Apache Commons Lang</a> i.e.:

      * <pre>

      * <dependency>

      *   <groupId>commons-lang</groupId>

      *   <artifactId>commons-lang</artifactId>

      * </dependency>

      * </pre>

      * The added Javadoc <code>-link</code> parameter will be <code>http://commons.apache.org/lang/apidocs</code>.

      *

      * @parameter expression="${detectLinks}" default-value="false"

      * @see #links

      * @since 2.6

      */

     private boolean detectLinks;

     /**

      * Detect the links for all modules defined in the project.

      * <br/>

      * If {@link #reactorProjects} is defined in a non-aggregator way, it generates default offline links

      * between modules based on the defined project's urls. For instance, if a parent project has two projects

      * <code>module1</code> and <code>module2</code>, the <code>-linkoffline</code> will be:

      * <br/>

      * The added Javadoc <code>-linkoffline</code> parameter for <b>module1</b> will be

      * <code>/absolute/path/to/</code><b>module2</b><code>/target/site/apidocs</code>

      * <br/>

      * The added Javadoc <code>-linkoffline</code> parameter for <b>module2</b> will be

      * <code>/absolute/path/to/</code><b>module1</b><code>/target/site/apidocs</code>

      *

      * @parameter expression="${detectOfflineLinks}" default-value="true"

      * @see #offlineLinks

      * @since 2.6

      */

     private boolean detectOfflineLinks;

     /**

      * Detect the Java API link for the current build, i.e. <code>http://java.sun.com/j2se/1.4.2/docs/api</code>

      * for Java source 1.4.

      * <br/>

      * By default, the goal detects the Javadoc API link depending the value of the <code>source</code>

      * parameter in the <code>org.apache.maven.plugins:maven-compiler-plugin</code>

      * (defined in <code>${project.build.plugins}</code> or in <code>${project.build.pluginManagement}</code>),

      * or try to compute it from the {@link #javadocExecutable} version.

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.html#DEFAULT_JAVA_API_LINKS">Javadoc</a> for the default values.

      * <br/>

      *

      * @parameter expression="${detectJavaApiLink}" default-value="true"

      * @see #links

      * @see #javaApiLinks

      * @see #DEFAULT_JAVA_API_LINKS

      * @since 2.6

      */

     private boolean detectJavaApiLink;

     /**

      * Use this parameter <b>only</b> if the <a href="http://java.sun.com/reference/api/index.html">Sun Javadoc API</a>

      * urls have been changed or to use custom urls for Javadoc API url.

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.html#DEFAULT_JAVA_API_LINKS">Javadoc</a>

      * for the default values.

      * <br/>

      *

      * @parameter expression="${javaApiLinks}"

      * @see #DEFAULT_JAVA_API_LINKS

      * @since 2.6

      */

     private Properties javaApiLinks;

     // ----------------------------------------------------------------------

     // Javadoc Options - all alphabetical

     // ----------------------------------------------------------------------

     /**

      * Specifies the paths where the boot classes reside. The <code>bootclasspath</code> can contain multiple paths

      * by separating them with a colon (<code>:</code>) or a semi-colon (<code>;</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bootclasspath">bootclasspath</a>.

      * <br/>

      *

      * @parameter expression="${bootclasspath}"

      * @since 2.5

      */

     private String bootclasspath;

     /**

      * Specifies the artifacts where the boot classes reside.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bootclasspath">bootclasspath</a>.

      * <br/>

      * Example:

      * <pre>

      * <bootclasspathArtifacts>

      *   <bootclasspathArtifact>

      *     <groupId>my-groupId</groupId>

      *     <artifactId>my-artifactId</artifactId>

      *     <version>my-version</version>

      *   </bootclasspathArtifact>

      * </bootclasspathArtifacts>

      * </pre>

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/BootclasspathArtifact.html">Javadoc</a>.

      * <br/>

      *

      * @parameter expression="${bootclasspathArtifacts}"

      * @since 2.5

      */

     private BootclasspathArtifact[] bootclasspathArtifacts;

     /**

      * Uses the sentence break iterator to determine the end of the first sentence.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#breakiterator">breakiterator</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      * <br/>

      *

      * @parameter expression="${breakiterator}" default-value="false"

      */

     private boolean breakiterator;

     /**

      * Specifies the class file that starts the doclet used in generating the documentation.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#doclet">doclet</a>.

      *

      * @parameter expression="${doclet}"

      */

     private String doclet;

     /**

      * Specifies the artifact containing the doclet starting class file (specified with the <code>-doclet</code>

      * option).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath">docletpath</a>.

      * <br/>

      * Example:

      * <pre>

      * <docletArtifact>

      *   <groupId>com.sun.tools.doclets</groupId>

      *   <artifactId>doccheck</artifactId>

      *   <version>1.2b2</version>

      * </docletArtifact>

      * </pre>

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/DocletArtifact.html">Javadoc</a>.

      * <br/>

      *

      * @parameter expression="${docletArtifact}"

      */

     private DocletArtifact docletArtifact;

     /**

      * Specifies multiple artifacts containing the path for the doclet starting class file (specified with the

      * <code>-doclet</code> option).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath">docletpath</a>.

      * <br/>

      * Example:

      * <pre>

      * <docletArtifacts>

      *   <docletArtifact>

      *     <groupId>com.sun.tools.doclets</groupId>

      *     <artifactId>doccheck</artifactId>

      *     <version>1.2b2</version>

      *   </docletArtifact>

      * </docletArtifacts>

      * </pre>

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/DocletArtifact.html">Javadoc</a>.

      * <br/>

      *

      * @since 2.1

      * @parameter expression="${docletArtifacts}"

      */

     private DocletArtifact[] docletArtifacts;

     /**

      * Specifies the path to the doclet starting class file (specified with the <code>-doclet</code> option) and

      * any jar files it depends on. The <code>docletPath</code> can contain multiple paths by separating them with

      * a colon (<code>:</code>) or a semi-colon (<code>;</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath">docletpath</a>.

      *

      * @parameter expression="${docletPath}"

      */

     private String docletPath;

     /**

      * Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the

      * <code>file.encoding</code> system property.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#encoding">encoding</a>.

      * <br/>

      * <b>Note</b>: In 2.4, the default value was locked to <code>ISO-8859-1</code> to ensure reproducing build, but

      * this was reverted in 2.5.

      * <br/>

      *

      * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"

      */

     private String encoding;

     /**

      * Unconditionally excludes the specified packages and their subpackages from the list formed by

      * <code>-subpackages</code>. Multiple packages can be separated by commas (<code>,</code>), colons (<code>:</code>)

      * or semicolons (<code>;</code>).

      * <br/>

      * Example:

      * <pre>

      * <excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>

      * </pre>

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#exclude">exclude</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      *

      * @parameter expression="${excludePackageNames}"

      */

     private String excludePackageNames;

     /**

      * Specifies the directories where extension classes reside. Separate directories in <code>extdirs</code> with a

      * colon (<code>:</code>) or a semi-colon (<code>;</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#extdirs">extdirs</a>.

      *

      * @parameter expression="${extdirs}"

      */

     private String extdirs;

     /**

      * Specifies the locale that javadoc uses when generating documentation.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#locale">locale</a>.

      *

      * @parameter expression="${locale}"

      */

     private String locale;

     /**

      * Specifies the maximum Java heap size to be used when launching the Javadoc tool.

      * JVMs refer to this property as the <code>-Xmx</code> parameter. Example: '512' or '512m'.

      * The memory unit depends on the JVM used. The units supported could be: <code>k</code>, <code>kb</code>,

      * <code>m</code>, <code>mb</code>, <code>g</code>, <code>gb</code>, <code>t</code>, <code>tb</code>.

      *  If no unit specified, the default unit is <code>m</code>.

      *

      * @parameter expression="${maxmemory}"

      */

     private String maxmemory;

     /**

      * Specifies the minimum Java heap size to be used when launching the Javadoc tool.

      * JVMs refer to this property as the <code>-Xms</code> parameter. Example: '512' or '512m'.

      * The memory unit depends on the JVM used. The units supported could be: <code>k</code>, <code>kb</code>,

      * <code>m</code>, <code>mb</code>, <code>g</code>, <code>gb</code>, <code>t</code>, <code>tb</code>.

      *  If no unit specified, the default unit is <code>m</code>.

      *

      * @parameter expression="${minmemory}"

      */

     private String minmemory;

     /**

      * This option creates documentation with the appearance and functionality of documentation generated by

      * Javadoc 1.1.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#1.1">1.1</a>.

      * <br/>

      *

      * @parameter expression="${old}" default-value="false"

      */

     private boolean old;

     /**

      * Specifies that javadoc should retrieve the text for the overview documentation from the "source" file

      * specified by path/filename and place it on the Overview page (overview-summary.html).

      * <br/>

      * <b>Note</b>: could be in conflict with &lt;nooverview/&gt;.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overview">overview</a>.

      * <br/>

      *

      * @parameter expression="${overview}" default-value="${basedir}/src/main/javadoc/overview.html"

      */

     private File overview;

     /**

      * Specifies the proxy host where the javadoc web access in <code>-link</code> would pass through.

      * It defaults to the proxy host of the active proxy set in the <code>settings.xml</code>, otherwise it gets the

      * proxy configuration set in the pom.

      * <br/>

      *

      * @parameter expression="${proxyHost}"

      * @deprecated since 2.4. Instead of, configure an active proxy host in <code>settings.xml</code>.

      */

     private String proxyHost;

     /**

      * Specifies the proxy port where the javadoc web access in <code>-link</code> would pass through.

      * It defaults to the proxy port of the active proxy set in the <code>settings.xml</code>, otherwise it gets the

      * proxy configuration set in the pom.

      * <br/>

      *

      * @parameter expression="${proxyPort}"

      * @deprecated since 2.4. Instead of, configure an active proxy port in <code>settings.xml</code>.

      */

     private int proxyPort;

     /**

      * Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them

      * easier to view.

      * <br/>

      * Note: was a standard doclet in Java 1.4.2 (refer to bug ID

      * <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4714350">4714350</a>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#quiet">quiet</a>.

      * <br/>

      * Since Java 5.0.

      * <br/>

      *

      * @parameter expression="${quiet}" default-value="false"

      */

     private boolean quiet;

     /**

      * Specifies the access level for classes and members to show in the Javadocs.

      * Possible values are:

      * <ul>

      * <li><a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#public">public</a>

      * (shows only public classes and members)</li>

      * <li><a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#protected">protected</a>

      * (shows only public and protected classes and members)</li>

      * <li><a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#package">package</a>

      * (shows all classes and members not marked private)</li>

      * <li><a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#private">private</a>

      * (shows all classes and members)</li>

      * </ul>

      * <br/>

      *

      * @parameter expression="${show}" default-value="protected"

      */

     private String show;

     /**

      * Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#source">source</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      *

      * @parameter expression="${source}"

      */

     private String source;

     /**

      * Specifies the source paths where the subpackages are located. The <code>sourcepath</code> can contain

      * multiple paths by separating them with a colon (<code>:</code>) or a semi-colon (<code>;</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#sourcepath">sourcepath</a>.

      *

      * @parameter expression="${sourcepath}"

      */

     private String sourcepath;

     /**

      * Specifies the package directory where javadoc will be executed. Multiple packages can be separated by

      * colons (<code>:</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#subpackages">subpackages</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      *

      * @parameter expression="${subpackages}"

      */

     private String subpackages;

     /**

      * Provides more detailed messages while javadoc is running.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#verbose">verbose</a>.

      * <br/>

      *

      * @parameter expression="${verbose}" default-value="false"

      */

     private boolean verbose;

     // ----------------------------------------------------------------------

     // Standard Doclet Options - all alphabetical

     // ----------------------------------------------------------------------

     /**

      * Specifies whether or not the author text is included in the generated Javadocs.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#author">author</a>.

      * <br/>

      *

      * @parameter expression="${author}" default-value="true"

      */

     private boolean author;

     /**

      * Specifies the text to be placed at the bottom of each output file.<br/>

      * If you want to use html you have to put it in a CDATA section, <br/>

      * eg. <code>&lt;![CDATA[Copyright 2005, &lt;a href="http://www.mycompany.com">MyCompany, Inc.&lt;a>]]&gt;</code>

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#bottom">bottom</a>.

      * <br/>

      *

      * @parameter expression="${bottom}"

      * default-value="Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved."

      */

     private String bottom;

     /**

      * Specifies the HTML character set for this document. If not specificed, the charset value will be the value of

      * the <code>docencoding</code> parameter.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#charset">charset</a>.

      * <br/>

      *

      * @parameter expression="${charset}"

      */

     private String charset;

     /**

      * Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be

      * <code>UTF-8</code>.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docencoding">docencoding</a>.

      *

      * @parameter expression="${docencoding}" default-value="${project.reporting.outputEncoding}"

      */

     private String docencoding;

     /**

      * Enables deep copying of the <code>&#42;&#42;/doc-files</code> directories and the specifc <code>resources</code>

      * directory from the <code>javadocDirectory</code> directory (for instance,

      * <code>src/main/javadoc/com/mycompany/myapp/doc-files</code> and <code>src/main/javadoc/resources</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs">

      * docfilessubdirs</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      * <br/>

      * See <a href="#javadocDirectory">javadocDirectory</a>.

      * <br/>

      *

      * @parameter expression="${docfilessubdirs}" default-value="false"

      * @see #excludedocfilessubdir

      * @see #javadocDirectory

      */

     private boolean docfilessubdirs;

     /**

      * Specifies the title to be placed near the top of the overview summary file.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#doctitle">doctitle</a>.

      * <br/>

      *

      * @parameter expression="${doctitle}" default-value="${project.name} ${project.version} API"

      */

     private String doctitle;

     /**

      * Excludes any "doc-files" subdirectories with the given names. Multiple patterns can be excluded

      * by separating them with colons (<code>:</code>).

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#excludedocfilessubdir">

      * excludedocfilessubdir</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      *

      * @parameter expression="${excludedocfilessubdir}"

      * @see #docfilessubdirs

      */

     private String excludedocfilessubdir;

     /**

      * Specifies the footer text to be placed at the bottom of each output file.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#footer">footer</a>.

      *

      * @parameter expression="${footer}"

      */

     private String footer;

     /**

      * Separates packages on the overview page into whatever groups you specify, one group per table. The

      * packages pattern can be any package name, or can be the start of any package name followed by an asterisk

      * (<code>*</code>) meaning "match any characters". Multiple patterns can be included in a group

      * by separating them with colons (<code>:</code>).

      * <br/>

      * Example:

      * <pre>

      * <groups>

      *   <group>

      *     <title>Core Packages</title>

      *     <!-- To includes java.lang, java.lang.ref,

      *     java.lang.reflect and only java.util

      *     (i.e. not java.util.jar) -->

      *     <packages>java.lang*:java.util</packages>

      *   </group>

      *   <group>

      *     <title>Extension Packages</title>

      *      <!-- To include javax.accessibility,

      *     javax.crypto, ... (among others) -->

      *     <packages>javax.*</packages>

      *   </group>

      * </groups>

      * </pre>

      * <b>Note</b>: using <code>java.lang.*</code> for <code>packages</code> would omit the <code>java.lang</code>

      * package but using <code>java.lang*</code> will include it.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#group">group</a>.

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/Group.html">Javadoc</a>.

      * <br/>

      *

      * @parameter expression="${groups}"

      */

     private Group[] groups;

     /**

      * Specifies the header text to be placed at the top of each output file.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#header">header</a>.

      *

      * @parameter expression="${header}"

      */

     private String header;

     /**

      * Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom

      * navigation bars link to.

      * <br/>

      * <b>Note</b>: could be in conflict with &lt;nohelp/&gt;.

      * <br/>

      * The <code>helpfile</code> could be an absolute File path.

      * <br/>

      * Since 2.6, it could be also be a path from a resource in the current project source directories

      * (i.e. <code>src/main/java</code>, <code>src/main/resources</code> or <code>src/main/javadoc</code>)

      *  or from a resource in the Javadoc plugin dependencies, for instance:

      * <pre>

      * <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>

      * </pre>

      * Where <code>path/to/your/resource/yourhelp-doc.html</code> could be in <code>src/main/javadoc</code>.

      * <pre>

      * <build>

      *   <plugins>

      *     <plugin>

      *       <groupId>org.apache.maven.plugins</groupId>

      *       <artifactId>maven-javadoc-plugin</artifactId>

      *       <configuration>

      *         <helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>

      *         ...

      *       </configuration>

      *       <dependencies>

      *         <dependency>

      *           <groupId>groupId</groupId>

      *           <artifactId>artifactId</artifactId>

      *           <version>version</version>

      *         </dependency>

      *       </dependencies>

      *     </plugin>

      *     ...

      *   <plugins>

      * </build>

      * </pre>

      * Where <code>path/to/your/resource/yourhelp-doc.html</code> is defined in the

      * <code>groupId:artifactId:version</code> javadoc plugin dependency.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#helpfile">helpfile</a>.

      *

      * @parameter expression="${helpfile}"

      */

     private String helpfile;

     /**

      * Adds HTML meta keyword tags to the generated file for each class.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#keywords">keywords</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions">

      * Java 1.4.2</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#commandlineoptions">

      * Java 5.0</a>.

      * <br/>

      *

      * @since 2.1

      * @parameter expression="${keywords}" default-value="false"

      */

     private boolean keywords;

     /**

      * Creates links to existing javadoc-generated documentation of external referenced classes.

      * <br/>

      * <b>Notes</b>:

      * <ol>

      * <li>only used is {@link #isOffline} is set to <code>false</code>.</li>

      * <li>all given links should have a fetchable <code>/package-list</code> file. For instance:

      * <pre>

      * <links>

      *   <link>http://java.sun.com/j2se/1.4.2/docs/api</link>

      * <links>

      * </pre>

      * will be used because <code>http://java.sun.com/j2se/1.4.2/docs/api/package-list</code> exists.</li>

      * <li>if {@link #detectLinks} is defined, the links between the project dependencies are

      * automatically added.</li>

      * <li>if {@link #detectJavaApiLink} is defined, a Java API link, based on the Java verion of the

      * project's sources, will be added automatically.</li>

      * </ol>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#link">link</a>.

      *

      * @parameter expression="${links}"

      * @see #detectLinks

      * @see #detectJavaApiLink

      */

     protected ArrayList<String> links;

     /**

      * Creates an HTML version of each source file (with line numbers) and adds links to them from the standard

      * HTML documentation.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#linksource">linksource</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      * <br/>

      *

      * @parameter expression="${linksource}" default-value="false"

      */

     private boolean linksource;

     /**

      * Suppress the entire comment body, including the main description and all tags, generating only declarations.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nocomment">nocomment</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      * <br/>

      *

      * @parameter expression="${nocomment}" default-value="false"

      */

     private boolean nocomment;

     /**

      * Prevents the generation of any deprecated API at all in the documentation.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nodeprecated">nodeprecated</a>.

      * <br/>

      *

      * @parameter expression="${nodeprecated}" default-value="false"

      */

     private boolean nodeprecated;

     /**

      * Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the

      * link in the navigation bar to that page.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nodeprecatedlist">

      * nodeprecatedlist</a>.

      * <br/>

      *

      * @parameter expression="${nodeprecatedlist}" default-value="false"

      */

     private boolean nodeprecatedlist;

     /**

      * Omits the HELP link in the navigation bars at the top and bottom of each page of output.

      * <br/>

      * <b>Note</b>: could be in conflict with &lt;helpfile/&gt;.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nohelp">nohelp</a>.

      * <br/>

      *

      * @parameter expression="${nohelp}" default-value="false"

      */

     private boolean nohelp;

     /**

      * Omits the index from the generated docs.

      * <br/>

      * <b>Note</b>: could be in conflict with &lt;splitindex/&gt;.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noindex">noindex</a>.

      * <br/>

      *

      * @parameter expression="${noindex}" default-value="false"

      */

     private boolean noindex;

     /**

      * Omits the navigation bar from the generated docs.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nonavbar">nonavbar</a>.

      * <br/>

      *

      * @parameter expression="${nonavbar}" default-value="false"

      */

     private boolean nonavbar;

     /**

      * Omits the entire overview page from the generated docs.

      * <br/>

      * <b>Note</b>: could be in conflict with &lt;overview/&gt;.

      * <br/>

      * Standard Doclet undocumented option.

      * <br/>

      *

      * @since 2.4

      * @parameter expression="${nooverview}" default-value="false"

      */

     private boolean nooverview;

     /**

      * Omits qualifying package name from ahead of class names in output.

      * Example:

      * <pre>

      * <noqualifier>all</noqualifier>

      * or

      * <noqualifier>packagename1:packagename2</noqualifier>

      * </pre>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noqualifier">noqualifier</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">Java 1.4</a>.

      *

      * @parameter expression="${noqualifier}"

      */

     private String noqualifier;

     /**

      * Omits from the generated docs the "Since" sections associated with the since tags.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nosince">nosince</a>.

      * <br/>

      *

      * @parameter expression="${nosince}" default-value="false"

      */

     private boolean nosince;

     /**

      * Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#notimestamp">notimestamp</a>.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#commandlineoptions">

      * Java 5.0</a>.

      * <br/>

      *

      * @since 2.1

      * @parameter expression="${notimestamp}" default-value="false"

      */

     private boolean notimestamp;

     /**

      * Omits the class/interface hierarchy pages from the generated docs.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#notree">notree</a>.

      * <br/>

      *

      * @parameter expression="${notree}" default-value="false"

      */

     private boolean notree;

     /**

      * This option is a variation of <code>-link</code>; they both create links to javadoc-generated documentation

      * for external referenced classes.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#linkoffline">linkoffline</a>.

      * <br/>

      * Example:

      * <pre>

      * <offlineLinks>

      *   <offlineLink>

      *     <url>http://java.sun.com/j2se/1.5.0/docs/api/</url>

      *     <location>../javadoc/jdk-5.0/</location>

      *   </offlineLink>

      * </offlineLinks>

      * </pre>

      * <br/>

      * <b>Note</b>: if {@link #detectOfflineLinks} is defined, the offline links between the project modules are

      * automatically added if the goal is calling in a non-aggregator way.

      * <br/>

      * See <a href="./apidocs/org/apache/maven/plugin/javadoc/options/OfflineLink.html">Javadoc</a>.

      * <br/>

      *

      * @parameter expression="${offlineLinks}"

      */

     private OfflineLink[] offlineLinks;

     /**

      * Specifies the destination directory where javadoc saves the generated HTML files.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.

      * <br/>

      *

      * @parameter expression="${destDir}" alias="destDir" default-value="${project.build.directory}/apidocs"

      * @required

      */

     protected File outputDirectory;

     /**

      * Specify the text for upper left frame.

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions">

      * Java 1.4.2</a>.

      *

      * @since 2.1

      * @parameter expression="${packagesheader}"

      */

     private String packagesheader;

     /**

      * Generates compile-time warnings for missing serial tags.

      * <br/>

      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#serialwarn">serialwarn</a>

      * <br/>

      *

      * @parameter expression="${serialwarn}" default-value="false"

      */

     private boolean serialwarn;

     /**

      * Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default

      * space is used.

      * <br/>

      * Note: was <code>linksourcetab</code> in Java 1.4.2 (refer to bug ID

      * <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4788919">4788919</a>).

      * <br/>

      * Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions">

      * 1.4.2</a>.

      * <br/>

      * Since Java 5.0.

      *

      * @since 2.1

      * @parameter expression="${sourcetab}" alias="linksourcetab"

      */

     private int sourcetab;

     /**

      * Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index

      * entries that start with non-alphabetical characters.

      * <br/>

      * <b>Note</b>: could be in conflict with &lt;noindex/&gt;.

      * <br/>