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 5b3197276..dda247e70 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; + /** + *
Constructor for AbstractFixJavadocMojo.
+ * + * @param inputHandler a {@link org.codehaus.plexus.components.interactivity.InputHandler} object + */ public AbstractFixJavadocMojo(InputHandler inputHandler) { this.inputHandler = inputHandler; } @@ -397,9 +402,7 @@ public AbstractFixJavadocMojo(InputHandler inputHandler) { */ private ListGetter for the field project.
getArtifactType.
+ * * @param p not null maven project. * @return the artifact type. */ @@ -463,6 +473,8 @@ protected String getArtifactType(MavenProject p) { } /** + *getProjectSourceRoots.
+ * * @param p not null maven project. * @return the list of source paths for the given project. */ @@ -473,9 +485,11 @@ protected ListgetCompileClasspathElements.
+ * * @param p not null * @return the compile classpath elements - * @throws DependencyResolutionRequiredException + * @throws org.apache.maven.artifact.DependencyResolutionRequiredException * if any */ protected ListgetJavaMethodAsString.
+ * * @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 cb1384242..cddbccf11 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; + /** + *Constructor for AbstractJavadocMojo.
+ * + * @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 @@ protected boolean isTest() { return false; } + /** + *Getter for the field outputDirectory.
Getter for the field project.
getProjectBuildOutputDirs.
+ * * @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 @@ protected ListgetClassesFile.
+ * * @param project the project in which to find a classes file * @return null, the attached artifact file, or outputDirectory. */ @@ -1756,6 +1781,8 @@ protected File getClassesFile(MavenProject project) { } /** + *getProjectSourceRoots.
+ * * @param p not null maven project * @return the list of source paths for the given project */ @@ -1770,6 +1797,8 @@ protected ListgetExecutionProjectSourceRoots.
+ * * @param p not null maven project * @return the list of source paths for the execution project of the given project */ @@ -1784,6 +1813,8 @@ protected ListGetter for the field javadocDirectory.
Getter for the field doclint.
Getter for the field doctitle.
Getter for the field overview.
javadocdirectory
*/
protected File getOverview() {
@@ -1812,6 +1849,8 @@ protected File getOverview() {
}
/**
+ * Getter for the field windowtitle.
doExecute.
+ * + * @throws org.apache.maven.plugin.MojoExecutionException if any. + * @throws org.apache.maven.plugin.MojoFailureException if any. + */ protected abstract void doExecute() throws MojoExecutionException, MojoFailureException; + /** + *verifyRemovedParameter.
+ * + * @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 @@ private void verifyReplacedParameter(String oldParamName, String newParamNew) { * 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 @@ protected void executeReport(Locale unusedLocale) throws MavenReportException { * * @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 MapgetDependencyScopeFilter.
+ * + * @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 + *resolveDependency.
+ * + * @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 Artifact resolveDependency(Dependency dependency) throws MavenReportExcep } } + /** + *getToolchain.
+ * + * @return a {@link org.apache.maven.toolchain.Toolchain} object + */ protected final Toolchain getToolchain() { Toolchain tc = null; @@ -5496,6 +5561,8 @@ private boolean matches(DependencyLink d, Artifact artifact) { } /** + *getDefaultJavadocApiLink.
+ * * @return if {@code detectJavaApiLink}, the Java API link based on the {@code javaApiLinks} properties and the * value of thesource parameter in the
* org.apache.maven.plugins:maven-compiler-plugin
@@ -5632,6 +5699,8 @@ private SetisValidJavadocLink.
+ * * @param link not null * @param detectingtrue if the link is generated by
* detectLinks, or false otherwise
@@ -5838,7 +5907,7 @@ private static String getPluginParameter(MavenProject project, String pluginId,
* 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 @@ protected final File getJavadocOptionsFile() {
* 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 @@ protected void logError(String message, Throwable t) {
}
}
+ /**
+ * Getter for the field reactorProjects.
failOnError.
+ * * @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 @@ private ListisSkippedModule.
+ * * @param mavenProject the project that might be skipped * @returntrue if the project needs to be skipped from aggregate generation
*/
@@ -5978,6 +6056,8 @@ protected boolean isSkippedModule(MavenProject mavenProject) {
}
/**
+ * isSkippedJavadoc.
+ * * @param mavenProject the project that might be skipped * @returntrue 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 a20d60fb0..98fa1745a 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 @@
/**
* 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 36acbe862..e5c2872fc 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 @@
* Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
* * @since 2.6 + * @author elharo */ @Mojo( name = "aggregate-jar", @@ -53,6 +54,19 @@ public class AggregatorJavadocJarMojo extends JavadocJarMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + *Constructor for AggregatorJavadocJarMojo.
+ * + * @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 AggregatorJavadocJarMojo( } // 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 f062baa8f..fce5b4dc1 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 @@ * Javadoc Tool. * * @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 + /** + *Constructor for AggregatorJavadocNoForkReport.
+ * + * @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 4bd99e8d8..41e28813d 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 @@ public class AggregatorJavadocReport extends JavadocReport { @Inject + /** + *Constructor for AggregatorJavadocReport.
+ * + * @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 AggregatorJavadocReport( 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 f1a21ce15..cdb79fa13 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 @@ *Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.
* * @since 2.6 + * @author elharo */ @Mojo( name = "test-aggregate-jar", @@ -53,6 +54,19 @@ public class AggregatorTestJavadocJarMojo extends TestJavadocJarMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + *Constructor for AggregatorTestJavadocJarMojo.
+ * + * @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 AggregatorTestJavadocJarMojo( } // 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 0ac6aca1c..b89a50197 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 @@ * * @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 + /** + *Constructor for AggregatorTestJavadocNoForkReport.
+ * + * @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 06db5a725..97a74c041 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 @@ public class AggregatorTestJavadocReport extends TestJavadocReport { @Inject + /** + *Constructor for AggregatorTestJavadocReport.
+ * + * @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 AggregatorTestJavadocReport( 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 4e3e4c3cf..8853ba4f9 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 @@ * 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; + /** + *Getter for the field url.
Setter for the field url.
Getter for the field groupId.
Setter for the field groupId.
Getter for the field artifactId.
Setter for the field artifactId.
Getter for the field classifier.
Setter for the field classifier.
Java code for the project.
+ *
* @see Where Tags
* Can Be Used
* @author Vincent Siveton
@@ -38,6 +39,11 @@
public class FixJavadocMojo extends AbstractFixJavadocMojo {
@Inject
+ /**
+ * Constructor for FixJavadocMojo.
+ * + * @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 5dbe8d016..df29118dc 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 @@ * For backwards compatibility, a custom archive configuration that defaults to not including the Maven descriptor. * * @see MJAVADOC-431 + * @author elharo */ public class JavadocArchiveConfiguration extends MavenArchiveConfiguration { + /** + *Constructor for JavadocArchiveConfiguration.
+ */ 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 f5d8ae189..ead482f4d 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 @@ * Javadoc Tool. * * @since 2.0 + * @author elharo */ @Mojo( name = "jar", @@ -96,6 +97,19 @@ public class JavadocJarMojo extends AbstractJavadocMojo { // CHECKSTYLE_OFF: ParameterNumber @Inject + /** + *Constructor for JavadocJarMojo.
+ * + * @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 @@ protected void doExecute() throws MojoExecutionException { // ---------------------------------------------------------------------- /** + *Getter for the field classifier.
javadoc or test-javadoc
*/
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 144a0f43b..93bb0384e 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 @@
* 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;
+ /**
+ * Constructor for JavadocModule.
+ * + * @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, CollectionConstructor for JavadocModule.
+ * + * @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 JavadocModule( this.moduleNameSource = moduleNameSource; } + /** + *Getter for the field gav.
Getter for the field sourcePaths.
Getter for the field artifactFile.
Getter for the field moduleDescriptor.
Getter for the field moduleNameSource.
Constructor for JavadocNoForkReport.
+ * + * @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 0b18ac5a1..bc2fabe74 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 + /** + *Constructor for JavadocReport.
+ * + * @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 void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws M } } - /** - * @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 dd8ccbc6c..440ca8127 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 @@ protected static String quotedPathArgument(String value) { * @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 @@ protected static Listmemory argument, the
* default unit is m. The units g | gb or t | tb will be converted in
* m.
- * @throws NullPointerException if the memory argument is null
- * @throws IllegalArgumentException if the memory argument doesn't match any pattern.
+ * @throws java.lang.NullPointerException if the memory argument is null
+ * @throws java.lang.IllegalArgumentException if the memory argument doesn't match any pattern.
*/
protected static String parseJavadocMemory(String memory) {
if (memory == null) {
@@ -662,10 +659,10 @@ protected static boolean validateEncoding(String charsetName) {
*
* @param jarFile not null
* @return the list of com.sun.tools.doclets.Taglet class names from a given jarFile.
- * @throws IOException if jarFile is invalid or not found, or if the JAVA_HOME/lib/tools.jar is not
+ * @throws java.io.IOException if jarFile is invalid or not found, or if the JAVA_HOME/lib/tools.jar 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 ListtoRelative.
+ * + * @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 static String toRelative(File basedir, String absolutePath) { /** * 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 static boolean isNotEmpty(final Collection> collection) { /** * 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 static boolean isEmpty(final Collection> collection) { * @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 @@ protected static URL getRedirectUrl(URL url, Settings settings) throws IOExcepti *false to only check the existence of the package-list resource.
* @return true if url points to a valid package-list resource;
* false 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 @@ protected static boolean isValidPackageList(URL url, Settings settings, boolean
}
}
+ /**
+ * isValidElementList.
+ * + * @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 bc196080e..89d57a9ef 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 @@ * Note: Ensure the methods match, although parse+compareTo+toString should be enough. * * - * * @author Robert Scholte * @since 3.0.0 * @deprecated Use {@link org.codehaus.plexus.languages.java.version.JavaVersion} instead @@ -50,6 +49,7 @@ static JavadocVersion parse(String s) { return new JavadocVersion(s); } + /** {@inheritDoc} */ @Override public int compareTo(JavadocVersion other) { String[] thisSegments = this.rawVersion.split("\\."); @@ -71,6 +71,7 @@ public int compareTo(JavadocVersion other) { 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 cf1d1ce45..d688f7dd6 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.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 theincludeDependencySources 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
+ /**
+ * Constructor for ResourcesBundleMojo.
+ * + * @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 6658a7e20..245134890 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 @@ /** * Helper class to compute and write data used to detect a * stale javadoc. + * + * @author elharo */ public class StaleHelper { @@ -59,7 +61,7 @@ private static Charset getDataCharset() { * * @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 ListConstructor for TestFixJavadocMojo.
+ * + * @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 b6d64b4f0..feee33378 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 + /** + *Constructor for TestJavadocJarMojo.
+ * + * @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 TestJavadocJarMojo( // Protected methods // ---------------------------------------------------------------------- + /** {@inheritDoc} */ @Override protected String getClassifier() { return testClassifier; @@ -155,26 +169,31 @@ protected String getClassifier() { // 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 ListConstructor for TestJavadocNoForkReport.
+ * + * @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 481f1be4b..f3f927f5b 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 + /** + *Constructor for TestJavadocReport.
+ * + * @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 TestJavadocReport( toolchainManager); } + /** {@inheritDoc} */ @Override protected void executeReport(Locale unusedLocale) throws MavenReportException { addMainJavadocLink(); @@ -165,6 +177,7 @@ protected void executeReport(Locale unusedLocale) throws MavenReportException { super.executeReport(unusedLocale); } + /** {@inheritDoc} */ @Override public String getName(Locale locale) { if (testName == null || testName.isEmpty()) { @@ -174,6 +187,7 @@ public String getName(Locale locale) { return testName; } + /** {@inheritDoc} */ @Override public String getDescription(Locale locale) { if (testDescription == null || testDescription.isEmpty()) { @@ -188,6 +202,7 @@ public String getDescription(Locale locale) { // Important Note: should be inline with methods defined in TestJavadocJar // ---------------------------------------------------------------------- + /** {@inheritDoc} */ @Override protected ListincludeDependencySources 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
+ /**
+ * Constructor for TestResourcesBundleMojo.
+ * + * @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 TestResourcesBundleMojo( @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 9bcad5571..e2fd3747c 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 org.apache.maven.plugins.javadoc.options.JavadocOptions; /** + *JavadocBundle class.
* + * @author elharo */ public class JavadocBundle { @@ -32,7 +34,9 @@ public class JavadocBundle { private final JavadocOptions options; /** - * @param options {@link JavadocOptions} + *Constructor for JavadocBundle.
+ * + * @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 JavadocBundle(final JavadocOptions options, final File resourcesDirectory } /** + *Getter for the field resourcesDirectory.
Getter for the field options.
ResourceResolver class.
* + * @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} + *resolveDependencyJavadocBundles.
+ * + * @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 ListresolveDependencySourcePaths.
+ * + * @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 CollectionSourceResolverConfig class.
* + * @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} + *Constructor for SourceResolverConfig.
+ * + * @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 SourceResolverConfig( } /** - * @param filter {@link AndFilter} - * @return {@link SourceResolverConfig} + *withFilter.
+ * + * @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 SourceResolverConfig withFilter(final AndFilter filter) { } /** + *withReactorProjects.
+ * * @param reactorProjects The list of reactor projects. - * @return {@link SourceResolverConfig} + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withReactorProjects(final ListwithCompileSources.
+ * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withCompileSources() { compileSourceIncluded = true; @@ -82,7 +92,9 @@ public SourceResolverConfig withCompileSources() { } /** - * @return {@link SourceResolverConfig} + *withoutCompileSources.
+ * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withoutCompileSources() { compileSourceIncluded = false; @@ -90,7 +102,9 @@ public SourceResolverConfig withoutCompileSources() { } /** - * @return {@link SourceResolverConfig} + *withTestSources.
+ * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withTestSources() { testSourceIncluded = true; @@ -98,7 +112,9 @@ public SourceResolverConfig withTestSources() { } /** - * @return {@link SourceResolverConfig} + *withoutTestSources.
+ * + * @return {@link org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig} */ public SourceResolverConfig withoutTestSources() { testSourceIncluded = false; @@ -106,34 +122,44 @@ public SourceResolverConfig withoutTestSources() { } /** - * @return {@link MavenProject} + *project.
+ * + * @return {@link org.apache.maven.project.MavenProject} */ public MavenProject project() { return project; } /** - * @return {@link ProjectBuildingRequest} + *Getter for the field buildingRequest.
filter.
+ * + * @return {@link org.apache.maven.shared.artifact.filter.resolve.AndFilter} */ public AndFilter filter() { return filter; } /** - * @return list of {@link MavenProject} + *reactorProjects.
+ * + * @return list of {@link org.apache.maven.project.MavenProject} */ public ListoutputBasedir.
+ * * @return {@link #outputBasedir} */ public File outputBasedir() { @@ -141,6 +167,8 @@ public File outputBasedir() { } /** + *includeCompileSources.
+ * * @return {@link #compileSourceIncluded} */ public boolean includeCompileSources() { @@ -148,6 +176,8 @@ public boolean includeCompileSources() { } /** + *includeTestSources.
+ * * @return {@link #testSourceIncluded} */ public boolean includeTestSources() {