This is an automated email from the ASF dual-hosted git repository. elharo pushed a commit to branch fixj in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
commit 4c8d968bac5e80f69dc7beac1dec14fcae1aff84 Author: Elliotte Rusty Harold <[email protected]> AuthorDate: Wed Aug 20 07:23:49 2025 -0400 Run mvn javadoc:fix --- .../plugins/javadoc/AbstractFixJavadocMojo.java | 24 ++++- .../maven/plugins/javadoc/AbstractJavadocMojo.java | 108 ++++++++++++++++++--- .../plugins/javadoc/AdditionalDependency.java | 4 +- .../plugins/javadoc/AggregatorJavadocJarMojo.java | 15 +++ .../javadoc/AggregatorJavadocNoForkReport.java | 12 +++ .../plugins/javadoc/AggregatorJavadocReport.java | 12 +++ .../javadoc/AggregatorTestJavadocJarMojo.java | 15 +++ .../javadoc/AggregatorTestJavadocNoForkReport.java | 12 +++ .../javadoc/AggregatorTestJavadocReport.java | 12 +++ .../maven/plugins/javadoc/DependencyLink.java | 41 ++++++++ .../maven/plugins/javadoc/FixJavadocMojo.java | 6 ++ .../javadoc/JavadocArchiveConfiguration.java | 4 + .../maven/plugins/javadoc/JavadocJarMojo.java | 16 +++ .../maven/plugins/javadoc/JavadocModule.java | 42 ++++++++ .../maven/plugins/javadoc/JavadocNoForkReport.java | 11 +++ .../maven/plugins/javadoc/JavadocReport.java | 15 ++- .../apache/maven/plugins/javadoc/JavadocUtil.java | 51 ++++++---- .../maven/plugins/javadoc/JavadocVersion.java | 3 +- .../maven/plugins/javadoc/ResourcesBundleMojo.java | 15 ++- .../apache/maven/plugins/javadoc/StaleHelper.java | 6 +- .../apache/maven/plugins/javadoc/SystemUtils.java | 2 +- .../maven/plugins/javadoc/TestFixJavadocMojo.java | 5 + .../maven/plugins/javadoc/TestJavadocJarMojo.java | 23 +++++ .../plugins/javadoc/TestJavadocNoForkReport.java | 11 +++ .../maven/plugins/javadoc/TestJavadocReport.java | 23 +++++ .../plugins/javadoc/TestResourcesBundleMojo.java | 20 +++- .../plugins/javadoc/resolver/JavadocBundle.java | 10 +- .../plugins/javadoc/resolver/ResourceResolver.java | 18 ++-- .../javadoc/resolver/SourceResolverConfig.java | 56 ++++++++--- 29 files changed, 524 insertions(+), 68 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java index 5b319727..dda247e7 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java @@ -220,6 +220,11 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo { */ private InputHandler inputHandler; + /** + * <p>Constructor for AbstractFixJavadocMojo.</p> + * + * @param inputHandler a {@link org.codehaus.plexus.components.interactivity.InputHandler} object + */ public AbstractFixJavadocMojo(InputHandler inputHandler) { this.inputHandler = inputHandler; } @@ -397,9 +402,7 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo { */ private List<String> sinceClasses; - /** - * {@inheritDoc} - */ + /** {@inheritDoc} */ @Override public void execute() throws MojoExecutionException, MojoFailureException { if (!fixClassComment && !fixFieldComment && !fixMethodComment) { @@ -450,11 +453,18 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo { // protected methods // ---------------------------------------------------------------------- + /** + * <p>Getter for the field <code>project</code>.</p> + * + * @return a {@link org.apache.maven.project.MavenProject} object + */ protected final MavenProject getProject() { return project; } /** + * <p>getArtifactType.</p> + * * @param p not null maven project. * @return the artifact type. */ @@ -463,6 +473,8 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo { } /** + * <p>getProjectSourceRoots.</p> + * * @param p not null maven project. * @return the list of source paths for the given project. */ @@ -473,9 +485,11 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo { } /** + * <p>getCompileClasspathElements.</p> + * * @param p not null * @return the compile classpath elements - * @throws DependencyResolutionRequiredException + * @throws org.apache.maven.artifact.DependencyResolutionRequiredException * if any */ protected List<String> getCompileClasspathElements(MavenProject p) throws DependencyResolutionRequiredException { @@ -485,6 +499,8 @@ public abstract class AbstractFixJavadocMojo extends AbstractMojo { } /** + * <p>getJavaMethodAsString.</p> + * * @param javaExecutable not null * @return the fully qualify name of javaMethod with signature */ diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java index cb138424..cddbccf1 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java @@ -253,6 +253,17 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { private ToolchainManager toolchainManager; + /** + * <p>Constructor for AbstractJavadocMojo.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AbstractJavadocMojo( SiteTool siteTool, ArchiverManager archiverManager, @@ -1694,6 +1705,11 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { return false; } + /** + * <p>Getter for the field <code>outputDirectory</code>.</p> + * + * @return a {@link java.lang.String} object + */ protected String getOutputDirectory() { return outputDirectory.getAbsolutePath(); } @@ -1708,11 +1724,18 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { return getOutputDirectory() + "/" + (isTest() ? "test" : "") + "apidocs"; } + /** + * <p>Getter for the field <code>project</code>.</p> + * + * @return a {@link org.apache.maven.project.MavenProject} object + */ protected MavenProject getProject() { return project; } /** + * <p>getProjectBuildOutputDirs.</p> + * * @param p not null maven project * @return the list of directories where compiled classes are placed for the given project. These dirs are * added to the javadoc classpath. @@ -1726,6 +1749,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>getClassesFile.</p> + * * @param project the project in which to find a classes file * @return null, the attached artifact file, or outputDirectory. */ @@ -1756,6 +1781,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>getProjectSourceRoots.</p> + * * @param p not null maven project * @return the list of source paths for the given project */ @@ -1770,6 +1797,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>getExecutionProjectSourceRoots.</p> + * * @param p not null maven project * @return the list of source paths for the execution project of the given project */ @@ -1784,6 +1813,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>Getter for the field <code>javadocDirectory</code>.</p> + * * @return the current javadoc directory */ protected File getJavadocDirectory() { @@ -1791,6 +1822,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>Getter for the field <code>doclint</code>.</p> + * * @return the doclint specific checks configuration */ protected String getDoclint() { @@ -1798,6 +1831,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>Getter for the field <code>doctitle</code>.</p> + * * @return the title to be placed near the top of the overview summary file */ protected String getDoctitle() { @@ -1805,6 +1840,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>Getter for the field <code>overview</code>.</p> + * * @return the overview documentation file from the user parameter or from the <code>javadocdirectory</code> */ protected File getOverview() { @@ -1812,6 +1849,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>Getter for the field <code>windowtitle</code>.</p> + * * @return the title to be placed in the HTML title tag */ protected String getWindowtitle() { @@ -1841,6 +1880,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { : encoding; } + /** {@inheritDoc} */ @Override public void execute() throws MojoExecutionException, MojoFailureException { verifyRemovedParameter("aggregator"); @@ -1851,8 +1891,19 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { doExecute(); } + /** + * <p>doExecute.</p> + * + * @throws org.apache.maven.plugin.MojoExecutionException if any. + * @throws org.apache.maven.plugin.MojoFailureException if any. + */ protected abstract void doExecute() throws MojoExecutionException, MojoFailureException; + /** + * <p>verifyRemovedParameter.</p> + * + * @param paramName a {@link java.lang.String} object + */ protected final void verifyRemovedParameter(String paramName) { Xpp3Dom configDom = mojoExecution.getConfiguration(); if (configDom != null) { @@ -1878,7 +1929,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { * Javadoc Options used by this Plugin. * * @param unusedLocale the wanted locale (actually unused). - * @throws MavenReportException if any + * @throws org.apache.maven.reporting.MavenReportException if any */ protected void executeReport(Locale unusedLocale) throws MavenReportException { if (getLog().isDebugEnabled()) { @@ -2087,7 +2138,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { * * @param sourcePaths a Collection that contains the paths to the source files * @return a List that contains the specific path for every source file - * @throws MavenReportException {@link MavenReportException} issue while generating report + * @throws org.apache.maven.reporting.MavenReportException {@link org.apache.maven.reporting.org.apache.maven.reporting.MavenReportException} issue while generating report */ protected Map<Path, Collection<String>> getFiles(Collection<Path> sourcePaths) throws MavenReportException { Map<Path, Collection<String>> mappedFiles = new LinkedHashMap<>(sourcePaths.size()); @@ -2128,7 +2179,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { * source roots of the project will be used. * * @return a Map of the project absolute source paths per projects key (G:A) - * @throws MavenReportException {@link MavenReportException} issue while generating report + * @throws org.apache.maven.reporting.MavenReportException {@link org.apache.maven.reporting.org.apache.maven.reporting.MavenReportException} issue while generating report * @see JavadocUtil#pruneDirs(MavenProject, Collection) */ protected Collection<JavadocModule> getSourcePaths() throws MavenReportException { @@ -2279,8 +2330,9 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { /** * Override this method to customize the configuration for resolving dependency sources. The default * behavior enables the resolution of -sources jar files. - * @param config {@link SourceResolverConfig} - * @return {@link SourceResolverConfig} + * + * @param config {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ protected SourceResolverConfig configureDependencySourceResolution(final SourceResolverConfig config) { return config.withCompileSources(); @@ -2288,9 +2340,10 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { /** * Resolve dependency sources so they can be included directly in the javadoc process. To customize this, - * override {@link AbstractJavadocMojo#configureDependencySourceResolution(SourceResolverConfig)}. + * override {@link org.apache.maven.plugins.javadoc.AbstractJavadocMojo#configureDependencySourceResolution(SourceResolverConfig)}. + * * @return List of source paths. - * @throws MavenReportException {@link MavenReportException} + * @throws org.apache.maven.reporting.MavenReportException {@link org.apache.maven.reporting.org.apache.maven.reporting.MavenReportException} */ protected final Collection<JavadocModule> getDependencySourcePaths() throws MavenReportException { try { @@ -2585,15 +2638,22 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { return classpathElements; } + /** + * <p>getDependencyScopeFilter.</p> + * + * @return a {@link org.eclipse.aether.util.filter.ScopeDependencyFilter} object + */ protected ScopeDependencyFilter getDependencyScopeFilter() { return new ScopeDependencyFilter( Arrays.asList(Artifact.SCOPE_COMPILE, Artifact.SCOPE_PROVIDED, Artifact.SCOPE_SYSTEM), null); } /** - * @param dependency {@link Dependency} - * @return {@link Artifact} - * @throws MavenReportException when artifact could not be resolved + * <p>resolveDependency.</p> + * + * @param dependency {@link org.apache.maven.model.Dependency} + * @return {@link org.apache.maven.artifact.Artifact} + * @throws org.apache.maven.reporting.MavenReportException when artifact could not be resolved */ public Artifact resolveDependency(Dependency dependency) throws MavenReportException { ArtifactTypeRegistry registry = RepositoryUtils.newArtifactTypeRegistry(artifactHandlerManager); @@ -2609,6 +2669,11 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } } + /** + * <p>getToolchain.</p> + * + * @return a {@link org.apache.maven.toolchain.Toolchain} object + */ protected final Toolchain getToolchain() { Toolchain tc = null; @@ -5496,6 +5561,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>getDefaultJavadocApiLink.</p> + * * @return if {@code detectJavaApiLink}, the Java API link based on the {@code javaApiLinks} properties and the * value of the <code>source</code> parameter in the * <code>org.apache.maven.plugins:maven-compiler-plugin</code> @@ -5632,6 +5699,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>isValidJavadocLink.</p> + * * @param link not null * @param detecting <code>true</code> if the link is generated by * <code>detectLinks</code>, or <code>false</code> otherwise @@ -5838,7 +5907,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { * Construct the output file for the generated javadoc-options XML file, after creating the * javadocOptionsDir if necessary. This method does NOT write to the file in question. * - * @return The options {@link File} file. + * @return The options {@link java.io.File} file. * @since 2.7 */ protected final File getJavadocOptionsFile() { @@ -5854,8 +5923,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { * supplying to a distro module in a includeDependencySources configuration, so the javadoc options * from this execution can be reconstructed and merged in the distro build. * - * @return {@link JavadocOptions} - * @throws IOException {@link IOException} + * @return {@link org.apache.maven.plugins.javadoc.options.JavadocOptions} + * @throws java.io.IOException {@link java.io.java.io.IOException} * @since 2.7 */ protected final JavadocOptions buildJavadocOptions() throws IOException { @@ -5914,14 +5983,21 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } } + /** + * <p>Getter for the field <code>reactorProjects</code>.</p> + * + * @return a {@link java.util.List} object + */ protected List<MavenProject> getReactorProjects() { return reactorProjects; } /** + * <p>failOnError.</p> + * * @param prefix the prefix of the exception * @param e the exception - * @throws MojoExecutionException {@link MojoExecutionException} issue while generating report + * @throws org.apache.maven.plugin.MojoExecutionException {@link org.apache.maven.plugin.org.apache.maven.plugin.MojoExecutionException} issue while generating report */ protected void failOnError(String prefix, Exception e) throws MojoExecutionException { if (failOnError) { @@ -5954,6 +6030,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>isSkippedModule.</p> + * * @param mavenProject the project that might be skipped * @return <code>true</code> if the project needs to be skipped from aggregate generation */ @@ -5978,6 +6056,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo { } /** + * <p>isSkippedJavadoc.</p> + * * @param mavenProject the project that might be skipped * @return <code>true</code> if the pom configuration skips javadoc generation for the project */ diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AdditionalDependency.java b/src/main/java/org/apache/maven/plugins/javadoc/AdditionalDependency.java index a20d60fb..98fa1745 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AdditionalDependency.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AdditionalDependency.java @@ -22,7 +22,9 @@ import org.apache.maven.model.Dependency; /** * Provides syntactic sugar for using the standard {@code Dependency} - * model as a parameter to {@link AbstractJavadocMojo}'s {@code additionalDependencies}. + * model as a parameter to {@link org.apache.maven.plugins.javadoc.AbstractJavadocMojo}'s {@code additionalDependencies}. + * + * @author elharo */ public class AdditionalDependency extends Dependency { // no op diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocJarMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocJarMojo.java index 36acbe86..e5c2872f 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocJarMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocJarMojo.java @@ -42,6 +42,7 @@ import org.eclipse.aether.RepositorySystem; * <p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> * * @since 2.6 + * @author elharo */ @Mojo( name = "aggregate-jar", @@ -53,6 +54,19 @@ public class AggregatorJavadocJarMojo extends JavadocJarMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for AggregatorJavadocJarMojo.</p> + * + * @param projectHelper a {@link org.apache.maven.project.MavenProjectHelper} object + * @param jarArchiver a {@link org.codehaus.plexus.archiver.jar.JarArchiver} object + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AggregatorJavadocJarMojo( MavenProjectHelper projectHelper, JarArchiver jarArchiver, @@ -76,6 +90,7 @@ public class AggregatorJavadocJarMojo extends JavadocJarMojo { } // CHECKSTYLE_ON: ParameterNumber + /** {@inheritDoc} */ @Override protected boolean isAggregator() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocNoForkReport.java b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocNoForkReport.java index f062baa8..fce5b4dc 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocNoForkReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocNoForkReport.java @@ -37,6 +37,7 @@ import org.eclipse.aether.RepositorySystem; * <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html";>Javadoc Tool</a>. * * @since 3.1.0 + * @author elharo */ @Mojo(name = "aggregate-no-fork", requiresDependencyResolution = ResolutionScope.COMPILE) @Execute(phase = LifecyclePhase.NONE) @@ -44,6 +45,17 @@ public class AggregatorJavadocNoForkReport extends AggregatorJavadocReport { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for AggregatorJavadocNoForkReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AggregatorJavadocNoForkReport( SiteTool siteTool, ArchiverManager archiverManager, diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReport.java index 4bd99e8d..41e28813 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReport.java @@ -46,6 +46,17 @@ import org.eclipse.aether.RepositorySystem; public class AggregatorJavadocReport extends JavadocReport { @Inject + /** + * <p>Constructor for AggregatorJavadocReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AggregatorJavadocReport( SiteTool siteTool, ArchiverManager archiverManager, @@ -64,6 +75,7 @@ public class AggregatorJavadocReport extends JavadocReport { toolchainManager); } + /** {@inheritDoc} */ @Override protected boolean isAggregator() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocJarMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocJarMojo.java index f1a21ce1..cdb79fa1 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocJarMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocJarMojo.java @@ -42,6 +42,7 @@ import org.eclipse.aether.RepositorySystem; * <p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p> * * @since 2.6 + * @author elharo */ @Mojo( name = "test-aggregate-jar", @@ -53,6 +54,19 @@ public class AggregatorTestJavadocJarMojo extends TestJavadocJarMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for AggregatorTestJavadocJarMojo.</p> + * + * @param projectHelper a {@link org.apache.maven.project.MavenProjectHelper} object + * @param jarArchiver a {@link org.codehaus.plexus.archiver.jar.JarArchiver} object + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AggregatorTestJavadocJarMojo( MavenProjectHelper projectHelper, JarArchiver jarArchiver, @@ -76,6 +90,7 @@ public class AggregatorTestJavadocJarMojo extends TestJavadocJarMojo { } // CHECKSTYLE_ON: ParameterNumber + /** {@inheritDoc} */ @Override protected boolean isAggregator() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocNoForkReport.java b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocNoForkReport.java index 0ac6aca1..b89a5019 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocNoForkReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocNoForkReport.java @@ -38,12 +38,24 @@ import org.eclipse.aether.RepositorySystem; * * @version $Id$ * @since 3.0.1 + * @author elharo */ @Mojo(name = "test-aggregate-no-fork", requiresDependencyResolution = ResolutionScope.TEST) @Execute(phase = LifecyclePhase.NONE) public class AggregatorTestJavadocNoForkReport extends AggregatorTestJavadocReport { @Inject + /** + * <p>Constructor for AggregatorTestJavadocNoForkReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AggregatorTestJavadocNoForkReport( SiteTool siteTool, ArchiverManager archiverManager, diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocReport.java index 06db5a72..97a74c04 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AggregatorTestJavadocReport.java @@ -46,6 +46,17 @@ import org.eclipse.aether.RepositorySystem; public class AggregatorTestJavadocReport extends TestJavadocReport { @Inject + /** + * <p>Constructor for AggregatorTestJavadocReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public AggregatorTestJavadocReport( SiteTool siteTool, ArchiverManager archiverManager, @@ -64,6 +75,7 @@ public class AggregatorTestJavadocReport extends TestJavadocReport { toolchainManager); } + /** {@inheritDoc} */ @Override protected boolean isAggregator() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/DependencyLink.java b/src/main/java/org/apache/maven/plugins/javadoc/DependencyLink.java index 4e3e4c3c..8853ba4f 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/DependencyLink.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/DependencyLink.java @@ -22,6 +22,7 @@ package org.apache.maven.plugins.javadoc; * In case of autodetectLinks, this class can overwrite the url for that dependency * * @since 3.3.0 + * @author elharo */ public class DependencyLink { private String groupId; @@ -32,34 +33,74 @@ public class DependencyLink { private String url; + /** + * <p>Getter for the field <code>url</code>.</p> + * + * @return a {@link java.lang.String} object + */ public String getUrl() { return url; } + /** + * <p>Setter for the field <code>url</code>.</p> + * + * @param url a {@link java.lang.String} object + */ public void setUrl(String url) { this.url = url; } + /** + * <p>Getter for the field <code>groupId</code>.</p> + * + * @return a {@link java.lang.String} object + */ public String getGroupId() { return groupId; } + /** + * <p>Setter for the field <code>groupId</code>.</p> + * + * @param groupId a {@link java.lang.String} object + */ public void setGroupId(String groupId) { this.groupId = groupId; } + /** + * <p>Getter for the field <code>artifactId</code>.</p> + * + * @return a {@link java.lang.String} object + */ public String getArtifactId() { return artifactId; } + /** + * <p>Setter for the field <code>artifactId</code>.</p> + * + * @param artifactId a {@link java.lang.String} object + */ public void setArtifactId(String artifactId) { this.artifactId = artifactId; } + /** + * <p>Getter for the field <code>classifier</code>.</p> + * + * @return a {@link java.lang.String} object + */ public String getClassifier() { return classifier; } + /** + * <p>Setter for the field <code>classifier</code>.</p> + * + * @param classifier a {@link java.lang.String} object + */ public void setClassifier(String classifier) { this.classifier = classifier; } diff --git a/src/main/java/org/apache/maven/plugins/javadoc/FixJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/FixJavadocMojo.java index 99511c1a..b312b67e 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/FixJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/FixJavadocMojo.java @@ -28,6 +28,7 @@ import org.codehaus.plexus.components.interactivity.InputHandler; /** * Fix Javadoc documentation and tags for the <code>Java code</code> for the project. + * * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used";>Where Tags * Can Be Used</a> * @author <a href="mailto:[email protected]";>Vincent Siveton</a> @@ -38,6 +39,11 @@ import org.codehaus.plexus.components.interactivity.InputHandler; public class FixJavadocMojo extends AbstractFixJavadocMojo { @Inject + /** + * <p>Constructor for FixJavadocMojo.</p> + * + * @param inputHandler a {@link org.codehaus.plexus.components.interactivity.InputHandler} object + */ public FixJavadocMojo(InputHandler inputHandler) { super(inputHandler); } diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocArchiveConfiguration.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocArchiveConfiguration.java index 5dbe8d01..df29118d 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocArchiveConfiguration.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocArchiveConfiguration.java @@ -24,8 +24,12 @@ import org.apache.maven.archiver.MavenArchiveConfiguration; * For backwards compatibility, a custom archive configuration that defaults to not including the Maven descriptor. * * @see <a href="https://issues.apache.org/browse/MJAVADOC-431";>MJAVADOC-431</a> + * @author elharo */ public class JavadocArchiveConfiguration extends MavenArchiveConfiguration { + /** + * <p>Constructor for JavadocArchiveConfiguration.</p> + */ public JavadocArchiveConfiguration() { setAddMavenDescriptor(false); } diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocJarMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocJarMojo.java index f5d8ae18..ead482f4 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocJarMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocJarMojo.java @@ -53,6 +53,7 @@ import org.eclipse.aether.RepositorySystem; * Javadoc Tool</a>. * * @since 2.0 + * @author elharo */ @Mojo( name = "jar", @@ -96,6 +97,19 @@ public class JavadocJarMojo extends AbstractJavadocMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for JavadocJarMojo.</p> + * + * @param projectHelper a {@link org.apache.maven.project.MavenProjectHelper} object + * @param jarArchiver a {@link org.codehaus.plexus.archiver.jar.JarArchiver} object + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public JavadocJarMojo( MavenProjectHelper projectHelper, JarArchiver jarArchiver, @@ -230,6 +244,8 @@ public class JavadocJarMojo extends AbstractJavadocMojo { // ---------------------------------------------------------------------- /** + * <p>Getter for the field <code>classifier</code>.</p> + * * @return the wanted classifier, i.e. <code>javadoc</code> or <code>test-javadoc</code> */ protected String getClassifier() { diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocModule.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocModule.java index 144a0f43..93bb0384 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocModule.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocModule.java @@ -29,6 +29,7 @@ import org.codehaus.plexus.languages.java.jpms.ModuleNameSource; * Represents a unit of Javadoc referring to the binary and java source paths * * @since 3.3.0 + * @author elharo */ public class JavadocModule { private final String gav; @@ -41,10 +42,26 @@ public class JavadocModule { private final ModuleNameSource moduleNameSource; + /** + * <p>Constructor for JavadocModule.</p> + * + * @param gav a {@link java.lang.String} object + * @param artifactFile a {@link java.io.File} object + * @param sourcePaths a {@link java.util.Collection} object + */ public JavadocModule(String gav, File artifactFile, Collection<Path> sourcePaths) { this(gav, artifactFile, sourcePaths, null, null); } + /** + * <p>Constructor for JavadocModule.</p> + * + * @param gav a {@link java.lang.String} object + * @param artifactFile a {@link java.io.File} object + * @param sourcePaths a {@link java.util.Collection} object + * @param moduleDescriptor a {@link org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor} object + * @param moduleNameSource a {@link org.codehaus.plexus.languages.java.jpms.ModuleNameSource} object + */ public JavadocModule( String gav, File artifactFile, @@ -58,22 +75,47 @@ public class JavadocModule { this.moduleNameSource = moduleNameSource; } + /** + * <p>Getter for the field <code>gav</code>.</p> + * + * @return a {@link java.lang.String} object + */ public String getGav() { return gav; } + /** + * <p>Getter for the field <code>sourcePaths</code>.</p> + * + * @return a {@link java.util.Collection} object + */ public Collection<Path> getSourcePaths() { return sourcePaths; } + /** + * <p>Getter for the field <code>artifactFile</code>.</p> + * + * @return a {@link java.io.File} object + */ public File getArtifactFile() { return artifactFile; } + /** + * <p>Getter for the field <code>moduleDescriptor</code>.</p> + * + * @return a {@link org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor} object + */ public JavaModuleDescriptor getModuleDescriptor() { return moduleDescriptor; } + /** + * <p>Getter for the field <code>moduleNameSource</code>.</p> + * + * @return a {@link org.codehaus.plexus.languages.java.jpms.ModuleNameSource} object + */ public ModuleNameSource getModuleNameSource() { return moduleNameSource; } diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java index b7b145fb..3cf1703a 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java @@ -47,6 +47,17 @@ import org.eclipse.aether.RepositorySystem; public class JavadocNoForkReport extends JavadocReport { @Inject + /** + * <p>Constructor for JavadocNoForkReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public JavadocNoForkReport( SiteTool siteTool, ArchiverManager archiverManager, diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java index 0b18ac5a..bc2fabe7 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java @@ -87,6 +87,17 @@ public class JavadocReport extends AbstractJavadocMojo implements MavenMultiPage private String description; @Inject + /** + * <p>Constructor for JavadocReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public JavadocReport( SiteTool siteTool, ArchiverManager archiverManager, @@ -148,9 +159,7 @@ public class JavadocReport extends AbstractJavadocMojo implements MavenMultiPage } } - /** - * @deprecated use getOutputPath() instead - */ + /** {@inheritDoc} */ @Override @Deprecated public String getOutputName() { diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java index dd8ccbc6..440ca812 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java @@ -277,7 +277,7 @@ public class JavadocUtil { * @param outputDirectory the output directory * @param javadocDir the javadoc directory * @param excludedocfilessubdir the excludedocfilessubdir parameter - * @throws IOException if any + * @throws java.io.IOException if any * @since 2.5 */ protected static void copyJavadocResources(File outputDirectory, File javadocDir, String excludedocfilessubdir) @@ -450,10 +450,9 @@ public class JavadocUtil { * * @param javadocExe not null file * @return the javadoc version as float - * @throws IOException if javadocExe is null, doesn't exist or is not a file - * @throws CommandLineException if any - * @throws IllegalArgumentException if no output was found in the command line - * @throws PatternSyntaxException if the output contains a syntax error in the regular-expression pattern. + * @throws java.io.IOException if javadocExe is null, doesn't exist or is not a file + * @throws org.codehaus.plexus.util.cli.CommandLineException if any + * @throws java.lang.IllegalArgumentException if no output was found in the command line * @see #extractJavadocVersion(String) */ protected static JavaVersion getJavadocVersion(File javadocExe) @@ -530,10 +529,8 @@ public class JavadocUtil { * * @param output of 'javadoc -J-version' * @return the version of the javadoc for the output, only digits and dots - * @throws PatternSyntaxException if the output doesn't match the output pattern - * {@code (?s).*?[^a-zA-Z]([0-9]+\\.?[0-9]*)(\\.([0-9]+))?.*}. - * @throws NullPointerException if the output is null - * @throws IllegalArgumentException if the output is empty + * @throws java.lang.NullPointerException if the output is null + * @throws java.lang.IllegalArgumentException if the output is empty */ protected static String extractJavadocVersion(String output) { if (output == null) { @@ -597,8 +594,8 @@ public class JavadocUtil { * @return the memory parsed with a supported unit. If no unit is specified in the <code>memory</code> argument, the * default unit is <code>m</code>. The units <code>g | gb</code> or <code>t | tb</code> will be converted in * <code>m</code>. - * @throws NullPointerException if the <code>memory</code> argument is null - * @throws IllegalArgumentException if the <code>memory</code> argument doesn't match any pattern. + * @throws java.lang.NullPointerException if the <code>memory</code> argument is null + * @throws java.lang.IllegalArgumentException if the <code>memory</code> argument doesn't match any pattern. */ protected static String parseJavadocMemory(String memory) { if (memory == null) { @@ -662,10 +659,10 @@ public class JavadocUtil { * * @param jarFile not null * @return the list of <code>com.sun.tools.doclets.Taglet</code> class names from a given jarFile. - * @throws IOException if jarFile is invalid or not found, or if the <code>JAVA_HOME/lib/tools.jar</code> is not + * @throws java.io.IOException if jarFile is invalid or not found, or if the <code>JAVA_HOME/lib/tools.jar</code> is not * found. - * @throws ClassNotFoundException if any - * @throws NoClassDefFoundError if any + * @throws java.lang.ClassNotFoundException if any + * @throws java.lang.NoClassDefFoundError if any */ protected static List<String> getTagletClassNames(File jarFile) throws IOException, ClassNotFoundException, NoClassDefFoundError { @@ -713,7 +710,7 @@ public class JavadocUtil { * * @param url not null url * @param file not null file where the url will be created - * @throws IOException if any + * @throws java.io.IOException if any * @since 2.6 */ protected static void copyResource(URL url, File file) throws IOException { @@ -743,7 +740,7 @@ public class JavadocUtil { * @param userSettingsFile reference to user settings file, could be null. * @param globalToolchainsFile reference to toolchains file, could be null. * @param userToolchainsFile reference to user toolchains file, could be null. - * @throws MavenInvocationException if any + * @throws org.apache.maven.shared.invoker.MavenInvocationException if any * @since 2.6 */ protected static void invokeMaven( @@ -1261,7 +1258,12 @@ public class JavadocUtil { } /** - * @deprecated use {@link Path#relativize(Path)} () instead + * <p>toRelative.</p> + * + * @deprecated use {@link java.nio.file.Path#relativize(Path)} () instead + * @param basedir a {@link java.io.File} object + * @param absolutePath a {@link java.lang.String} object + * @return a {@link java.lang.String} object */ @Deprecated public static String toRelative(File basedir, String absolutePath) { @@ -1287,6 +1289,7 @@ public class JavadocUtil { /** * Convenience method to determine that a collection is not empty or null. + * * @param collection the collection to verify * @return {@code true} if not {@code null} and not empty, otherwise {@code false} */ @@ -1296,6 +1299,7 @@ public class JavadocUtil { /** * Convenience method to determine that a collection is empty or null. + * * @param collection the collection to verify * @return {@code true} if {@code null} or empty, otherwise {@code false} */ @@ -1310,7 +1314,7 @@ public class JavadocUtil { * @param url URL * @param settings Maven settings * @return final URL after all redirects have been followed - * @throws IOException if there was an error during the HTTP request + * @throws java.io.IOException if there was an error during the HTTP request */ protected static URL getRedirectUrl(URL url, Settings settings) throws IOException { String protocol = url.getProtocol(); @@ -1362,7 +1366,7 @@ public class JavadocUtil { * <code>false</code> to only check the existence of the <code>package-list</code> resource. * @return <code>true</code> if <code>url</code> points to a valid <code>package-list</code> resource; * <code>false</code> else. - * @throws IOException if reading the resource fails. + * @throws java.io.IOException if reading the resource fails. * @see #createHttpClient(org.apache.maven.settings.Settings, java.net.URL) * @since 2.8 */ @@ -1384,6 +1388,15 @@ public class JavadocUtil { } } + /** + * <p>isValidElementList.</p> + * + * @param url a {@link java.net.URL} object + * @param settings a {@link org.apache.maven.settings.Settings} object + * @param validateContent a boolean + * @return a boolean + * @throws java.io.IOException if any. + */ protected static boolean isValidElementList(URL url, Settings settings, boolean validateContent) throws IOException { if (url == null) { diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocVersion.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocVersion.java index bc196080..89d57a9e 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocVersion.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocVersion.java @@ -24,7 +24,6 @@ package org.apache.maven.plugins.javadoc; * <strong>Note: </strong> Ensure the methods match, although parse+compareTo+toString should be enough. * </p> * - * * @author Robert Scholte * @since 3.0.0 * @deprecated Use {@link org.codehaus.plexus.languages.java.version.JavaVersion} instead @@ -50,6 +49,7 @@ public class JavadocVersion implements Comparable<JavadocVersion> { return new JavadocVersion(s); } + /** {@inheritDoc} */ @Override public int compareTo(JavadocVersion other) { String[] thisSegments = this.rawVersion.split("\\."); @@ -71,6 +71,7 @@ public class JavadocVersion implements Comparable<JavadocVersion> { return thisSegments.length - otherSegments.length; } + /** {@inheritDoc} */ @Override public String toString() { return rawVersion; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java index cf1d1ce4..d688f7dd 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/ResourcesBundleMojo.java @@ -43,12 +43,13 @@ import org.codehaus.plexus.archiver.util.DefaultFileSet; import org.eclipse.aether.RepositorySystem; /** - * Bundle {@link AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such + * Bundle {@link org.apache.maven.plugins.javadoc.AbstractJavadocMojo#javadocDirectory}, along with javadoc configuration options such * as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed * by the javadoc plugin mojos when used by the <code>includeDependencySources</code> option, to generate * javadocs that are somewhat consistent with those generated in the original project itself. * * @since 2.7 + * @author elharo */ @Mojo( name = "resource-bundle", @@ -88,6 +89,18 @@ public class ResourcesBundleMojo extends AbstractJavadocMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for ResourcesBundleMojo.</p> + * + * @param projectHelper a {@link org.apache.maven.project.MavenProjectHelper} object + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public ResourcesBundleMojo( MavenProjectHelper projectHelper, SiteTool siteTool, diff --git a/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java b/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java index 6658a7e2..24513489 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/StaleHelper.java @@ -37,6 +37,8 @@ import org.codehaus.plexus.util.cli.Commandline; /** * Helper class to compute and write data used to detect a * stale javadoc. + * + * @author elharo */ public class StaleHelper { @@ -59,7 +61,7 @@ public class StaleHelper { * * @param cmd the command line * @return the stale data - * @throws MavenReportException if an error occurs + * @throws org.apache.maven.reporting.MavenReportException if an error occurs */ public static List<String> getStaleData(Commandline cmd) throws MavenReportException { try { @@ -117,7 +119,7 @@ public class StaleHelper { * * @param cmd the command line * @param path the stale data path - * @throws MavenReportException if an error occurs + * @throws org.apache.maven.reporting.MavenReportException if an error occurs */ public static void writeStaleData(Commandline cmd, Path path) throws MavenReportException { try { diff --git a/src/main/java/org/apache/maven/plugins/javadoc/SystemUtils.java b/src/main/java/org/apache/maven/plugins/javadoc/SystemUtils.java index d17addba..4b5cbc65 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/SystemUtils.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/SystemUtils.java @@ -137,7 +137,7 @@ class SystemUtils { * </p> * * @return a directory - * @throws SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow + * @throws java.lang.SecurityException if a security manager exists and its {@code checkPropertyAccess} method doesn't allow * access to the specified system property. * @see System#getProperty(String) * @since 2.1 diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java index 2eea8800..a3705c5c 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/TestFixJavadocMojo.java @@ -46,6 +46,11 @@ import org.codehaus.plexus.components.interactivity.InputHandler; public class TestFixJavadocMojo extends AbstractFixJavadocMojo { @Inject + /** + * <p>Constructor for TestFixJavadocMojo.</p> + * + * @param inputHandler a {@link org.codehaus.plexus.components.interactivity.InputHandler} object + */ public TestFixJavadocMojo(InputHandler inputHandler) { super(inputHandler); } diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocJarMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocJarMojo.java index b6d64b4f..feee3337 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocJarMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocJarMojo.java @@ -63,6 +63,19 @@ public class TestJavadocJarMojo extends JavadocJarMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for TestJavadocJarMojo.</p> + * + * @param projectHelper a {@link org.apache.maven.project.MavenProjectHelper} object + * @param jarArchiver a {@link org.codehaus.plexus.archiver.jar.JarArchiver} object + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public TestJavadocJarMojo( MavenProjectHelper projectHelper, JarArchiver jarArchiver, @@ -146,6 +159,7 @@ public class TestJavadocJarMojo extends JavadocJarMojo { // Protected methods // ---------------------------------------------------------------------- + /** {@inheritDoc} */ @Override protected String getClassifier() { return testClassifier; @@ -155,26 +169,31 @@ public class TestJavadocJarMojo extends JavadocJarMojo { // Important Note: should be inline with methods defined in TestJavadocReport // ---------------------------------------------------------------------- + /** {@inheritDoc} */ @Override protected File getJavadocDirectory() { return testJavadocDirectory; } + /** {@inheritDoc} */ @Override protected String getDoctitle() { return testDoctitle; } + /** {@inheritDoc} */ @Override protected File getOverview() { return testOverview; } + /** {@inheritDoc} */ @Override protected String getWindowtitle() { return testWindowtitle; } + /** {@inheritDoc} */ @Override protected List<File> getProjectBuildOutputDirs(MavenProject p) { List<File> dirs = new ArrayList<>(); @@ -188,6 +207,7 @@ public class TestJavadocJarMojo extends JavadocJarMojo { return dirs; } + /** {@inheritDoc} */ @Override protected List<String> getProjectSourceRoots(MavenProject p) { if ("pom".equals(p.getPackaging().toLowerCase(Locale.ENGLISH))) { @@ -197,6 +217,7 @@ public class TestJavadocJarMojo extends JavadocJarMojo { return p.getTestCompileSourceRoots(); } + /** {@inheritDoc} */ @Override protected List<String> getExecutionProjectSourceRoots(MavenProject p) { if ("pom".equals(p.getExecutionProject().getPackaging().toLowerCase(Locale.ENGLISH))) { @@ -206,6 +227,7 @@ public class TestJavadocJarMojo extends JavadocJarMojo { return p.getExecutionProject().getTestCompileSourceRoots(); } + /** {@inheritDoc} */ @Override protected ScopeDependencyFilter getDependencyScopeFilter() { return new ScopeDependencyFilter( @@ -226,6 +248,7 @@ public class TestJavadocJarMojo extends JavadocJarMojo { .withTestSources(); } + /** {@inheritDoc} */ @Override protected boolean isTest() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java index bc78361c..cea84c5d 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java @@ -48,6 +48,17 @@ import org.eclipse.aether.RepositorySystem; public class TestJavadocNoForkReport extends TestJavadocReport { @Inject + /** + * <p>Constructor for TestJavadocNoForkReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public TestJavadocNoForkReport( SiteTool siteTool, ArchiverManager archiverManager, diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocReport.java index 481f1be4..f3f927f5 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocReport.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocReport.java @@ -140,6 +140,17 @@ public class TestJavadocReport extends JavadocReport { // ---------------------------------------------------------------------- @Inject + /** + * <p>Constructor for TestJavadocReport.</p> + * + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public TestJavadocReport( SiteTool siteTool, ArchiverManager archiverManager, @@ -158,6 +169,7 @@ public class TestJavadocReport extends JavadocReport { toolchainManager); } + /** {@inheritDoc} */ @Override protected void executeReport(Locale unusedLocale) throws MavenReportException { addMainJavadocLink(); @@ -165,6 +177,7 @@ public class TestJavadocReport extends JavadocReport { super.executeReport(unusedLocale); } + /** {@inheritDoc} */ @Override public String getName(Locale locale) { if (testName == null || testName.isEmpty()) { @@ -174,6 +187,7 @@ public class TestJavadocReport extends JavadocReport { return testName; } + /** {@inheritDoc} */ @Override public String getDescription(Locale locale) { if (testDescription == null || testDescription.isEmpty()) { @@ -188,6 +202,7 @@ public class TestJavadocReport extends JavadocReport { // Important Note: should be inline with methods defined in TestJavadocJar // ---------------------------------------------------------------------- + /** {@inheritDoc} */ @Override protected List<File> getProjectBuildOutputDirs(MavenProject p) { List<File> dirs = new ArrayList<>(); @@ -201,6 +216,7 @@ public class TestJavadocReport extends JavadocReport { return dirs; } + /** {@inheritDoc} */ @Override protected List<String> getProjectSourceRoots(MavenProject p) { if ("pom".equalsIgnoreCase(p.getPackaging())) { @@ -212,6 +228,7 @@ public class TestJavadocReport extends JavadocReport { : new LinkedList<>(p.getTestCompileSourceRoots()); } + /** {@inheritDoc} */ @Override protected List<String> getExecutionProjectSourceRoots(MavenProject p) { if ("pom".equals(p.getExecutionProject().getPackaging().toLowerCase(Locale.ENGLISH))) { @@ -223,26 +240,31 @@ public class TestJavadocReport extends JavadocReport { : new LinkedList<>(p.getExecutionProject().getTestCompileSourceRoots()); } + /** {@inheritDoc} */ @Override protected File getJavadocDirectory() { return testJavadocDirectory; } + /** {@inheritDoc} */ @Override protected String getDoctitle() { return testDoctitle; } + /** {@inheritDoc} */ @Override protected File getOverview() { return testOverview; } + /** {@inheritDoc} */ @Override protected String getWindowtitle() { return testWindowtitle; } + /** {@inheritDoc} */ @Override protected ScopeDependencyFilter getDependencyScopeFilter() { return new ScopeDependencyFilter( @@ -288,6 +310,7 @@ public class TestJavadocReport extends JavadocReport { .withTestSources(); } + /** {@inheritDoc} */ @Override protected boolean isTest() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestResourcesBundleMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/TestResourcesBundleMojo.java index d8846aa7..fce2804e 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/TestResourcesBundleMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/TestResourcesBundleMojo.java @@ -36,13 +36,14 @@ import org.codehaus.plexus.archiver.manager.ArchiverManager; import org.eclipse.aether.RepositorySystem; /** - * Bundle {@link TestJavadocJarMojo#testJavadocDirectory}, along with javadoc configuration options from - * {@link AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable + * Bundle {@link org.apache.maven.plugins.javadoc.TestJavadocJarMojo#testJavadocDirectory}, along with javadoc configuration options from + * {@link org.apache.maven.plugins.javadoc.AbstractJavadocMojo} such as taglet, doclet, and link information into a deployable * artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the * <code>includeDependencySources</code> option, to generate javadocs that are somewhat consistent * with those generated in the original project itself. * * @since 2.7 + * @author elharo */ @Mojo( name = "test-resource-bundle", @@ -53,6 +54,18 @@ public class TestResourcesBundleMojo extends ResourcesBundleMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + * <p>Constructor for TestResourcesBundleMojo.</p> + * + * @param projectHelper a {@link org.apache.maven.project.MavenProjectHelper} object + * @param siteTool a {@link org.apache.maven.doxia.tools.SiteTool} object + * @param archiverManager a {@link org.codehaus.plexus.archiver.manager.ArchiverManager} object + * @param resourceResolver a {@link org.apache.maven.plugins.javadoc.resolver.ResourceResolver} object + * @param repoSystem a {@link org.eclipse.aether.RepositorySystem} object + * @param artifactHandlerManager a {@link org.apache.maven.artifact.handler.manager.ArtifactHandlerManager} object + * @param mavenProjectBuilder a {@link org.apache.maven.project.ProjectBuilder} object + * @param toolchainManager a {@link org.apache.maven.toolchain.ToolchainManager} object + */ public TestResourcesBundleMojo( MavenProjectHelper projectHelper, SiteTool siteTool, @@ -80,16 +93,19 @@ public class TestResourcesBundleMojo extends ResourcesBundleMojo { @Parameter(alias = "javadocDirectory", defaultValue = "${basedir}/src/test/javadoc") private File testJavadocDirectory; + /** {@inheritDoc} */ @Override protected String getAttachmentClassifier() { return TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER; } + /** {@inheritDoc} */ @Override protected File getJavadocDirectory() { return testJavadocDirectory; } + /** {@inheritDoc} */ @Override protected boolean isTest() { return true; diff --git a/src/main/java/org/apache/maven/plugins/javadoc/resolver/JavadocBundle.java b/src/main/java/org/apache/maven/plugins/javadoc/resolver/JavadocBundle.java index 9bcad557..e2fd3747 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/resolver/JavadocBundle.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/resolver/JavadocBundle.java @@ -23,7 +23,9 @@ import java.io.File; import org.apache.maven.plugins.javadoc.options.JavadocOptions; /** + * <p>JavadocBundle class.</p> * + * @author elharo */ public class JavadocBundle { @@ -32,7 +34,9 @@ public class JavadocBundle { private final JavadocOptions options; /** - * @param options {@link JavadocOptions} + * <p>Constructor for JavadocBundle.</p> + * + * @param options {@link org.apache.maven.plugins.javadoc.options.JavadocOptions} * @param resourcesDirectory The resources directory. */ public JavadocBundle(final JavadocOptions options, final File resourcesDirectory) { @@ -41,6 +45,8 @@ public class JavadocBundle { } /** + * <p>Getter for the field <code>resourcesDirectory</code>.</p> + * * @return {@link #resourcesDirectory} */ public File getResourcesDirectory() { @@ -48,6 +54,8 @@ public class JavadocBundle { } /** + * <p>Getter for the field <code>options</code>.</p> + * * @return {@link #options} */ public JavadocOptions getOptions() { diff --git a/src/main/java/org/apache/maven/plugins/javadoc/resolver/ResourceResolver.java b/src/main/java/org/apache/maven/plugins/javadoc/resolver/ResourceResolver.java index 51d814b7..71afd182 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/resolver/ResourceResolver.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/resolver/ResourceResolver.java @@ -65,7 +65,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * <p>ResourceResolver class.</p> * + * @author elharo */ @Named @Singleton @@ -96,9 +98,11 @@ public final class ResourceResolver { AbstractJavadocMojo.TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER); /** - * @param config {@link SourceResolverConfig} - * @return list of {@link JavadocBundle}. - * @throws IOException {@link IOException} + * <p>resolveDependencyJavadocBundles.</p> + * + * @param config {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} + * @return list of {@link org.apache.maven.plugins.javadoc.resolver.JavadocBundle}. + * @throws java.io.IOException {@link java.io.java.io.IOException} */ public List<JavadocBundle> resolveDependencyJavadocBundles(final SourceResolverConfig config) throws IOException { final List<JavadocBundle> bundles = new ArrayList<>(); @@ -128,10 +132,12 @@ public final class ResourceResolver { } /** - * @param config {@link SourceResolverConfig} + * <p>resolveDependencySourcePaths.</p> + * + * @param config {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} * @return The list of resolved dependencies. - * @throws ArtifactResolutionException {@link ArtifactResolutionException} - * @throws ArtifactNotFoundException {@link ArtifactNotFoundException} + * @throws org.apache.maven.artifact.resolver.ArtifactResolutionException {@link org.apache.maven.artifact.resolver.org.apache.maven.artifact.resolver.ArtifactResolutionException} + * @throws org.apache.maven.artifact.resolver.ArtifactNotFoundException {@link org.apache.maven.artifact.resolver.org.apache.maven.artifact.resolver.ArtifactNotFoundException} */ public Collection<JavadocModule> resolveDependencySourcePaths(final SourceResolverConfig config) throws ArtifactResolutionException, ArtifactNotFoundException { diff --git a/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java b/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java index d1d82dbf..24c427f9 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/resolver/SourceResolverConfig.java @@ -26,7 +26,9 @@ import org.apache.maven.project.ProjectBuildingRequest; import org.apache.maven.shared.artifact.filter.resolve.AndFilter; /** + * <p>SourceResolverConfig class.</p> * + * @author elharo */ public class SourceResolverConfig { private ProjectBuildingRequest buildingRequest; @@ -44,8 +46,10 @@ public class SourceResolverConfig { private boolean testSourceIncluded; /** - * @param project {@link MavenProject} - * @param buildingRequest {@link ProjectBuildingRequest} + * <p>Constructor for SourceResolverConfig.</p> + * + * @param project {@link org.apache.maven.project.MavenProject} + * @param buildingRequest {@link org.apache.maven.project.ProjectBuildingRequest} * @param outputBasedir The output base directory. */ public SourceResolverConfig( @@ -56,8 +60,10 @@ public class SourceResolverConfig { } /** - * @param filter {@link AndFilter} - * @return {@link SourceResolverConfig} + * <p>withFilter.</p> + * + * @param filter {@link org.apache.maven.shared.artifact.filter.resolve.AndFilter} + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withFilter(final AndFilter filter) { this.filter = filter; @@ -65,8 +71,10 @@ public class SourceResolverConfig { } /** + * <p>withReactorProjects.</p> + * * @param reactorProjects The list of reactor projects. - * @return {@link SourceResolverConfig} + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withReactorProjects(final List<MavenProject> reactorProjects) { this.reactorProjects = reactorProjects; @@ -74,7 +82,9 @@ public class SourceResolverConfig { } /** - * @return {@link SourceResolverConfig} + * <p>withCompileSources.</p> + * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withCompileSources() { compileSourceIncluded = true; @@ -82,7 +92,9 @@ public class SourceResolverConfig { } /** - * @return {@link SourceResolverConfig} + * <p>withoutCompileSources.</p> + * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withoutCompileSources() { compileSourceIncluded = false; @@ -90,7 +102,9 @@ public class SourceResolverConfig { } /** - * @return {@link SourceResolverConfig} + * <p>withTestSources.</p> + * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withTestSources() { testSourceIncluded = true; @@ -98,7 +112,9 @@ public class SourceResolverConfig { } /** - * @return {@link SourceResolverConfig} + * <p>withoutTestSources.</p> + * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withoutTestSources() { testSourceIncluded = false; @@ -106,34 +122,44 @@ public class SourceResolverConfig { } /** - * @return {@link MavenProject} + * <p>project.</p> + * + * @return {@link org.apache.maven.project.MavenProject} */ public MavenProject project() { return project; } /** - * @return {@link ProjectBuildingRequest} + * <p>Getter for the field <code>buildingRequest</code>.</p> + * + * @return {@link org.apache.maven.project.ProjectBuildingRequest} */ public ProjectBuildingRequest getBuildingRequest() { return buildingRequest; } /** - * @return {@link AndFilter} + * <p>filter.</p> + * + * @return {@link org.apache.maven.shared.artifact.filter.resolve.AndFilter} */ public AndFilter filter() { return filter; } /** - * @return list of {@link MavenProject} + * <p>reactorProjects.</p> + * + * @return list of {@link org.apache.maven.project.MavenProject} */ public List<MavenProject> reactorProjects() { return reactorProjects; } /** + * <p>outputBasedir.</p> + * * @return {@link #outputBasedir} */ public File outputBasedir() { @@ -141,6 +167,8 @@ public class SourceResolverConfig { } /** + * <p>includeCompileSources.</p> + * * @return {@link #compileSourceIncluded} */ public boolean includeCompileSources() { @@ -148,6 +176,8 @@ public class SourceResolverConfig { } /** + * <p>includeTestSources.</p> + * * @return {@link #testSourceIncluded} */ public boolean includeTestSources() {
