diff --git a/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java b/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java index 415e59e3..23555347 100644 --- a/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java +++ b/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java @@ -202,7 +202,7 @@ protected static String appendSlash( final String url ) * can tweak algorithm to determine this top site by implementing determineTopDistributionManagementSiteUrl(). * * @return the site for deployment - * @throws MojoExecutionException + * @throws MojoExecutionException in case of issue * @see #determineTopDistributionManagementSiteUrl() */ protected String getTopDistributionManagementSiteUrl() @@ -229,7 +229,7 @@ protected abstract String determineTopDistributionManagementSiteUrl() * can tweak algorithm to determine this deploy site by implementing determineDeploySite(). * * @return the site for deployment - * @throws MojoExecutionException + * @throws MojoExecutionException in case of issue * @see #determineDeploySite() */ protected Site getDeploySite() @@ -249,7 +249,7 @@ protected abstract Site determineDeploySite() * Find the relative path between the distribution URLs of the top site and the current project. * * @return the relative path or "./" if the two URLs are the same. - * @throws MojoExecutionException + * @throws MojoExecutionException in case of issue */ protected String getDeployModuleDirectory() throws MojoExecutionException diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java index 65834795..829f6b37 100644 --- a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java +++ b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java @@ -49,7 +49,7 @@ public abstract class AbstractSiteDescriptorMojo /** * Remote repositories used for the project. * - * @todo this is used for site descriptor resolution - it should relate to the actual project but for some reason + * todo this is used for site descriptor resolution - it should relate to the actual project but for some reason * they are not always filled in */ @Parameter( defaultValue = "${project.remoteArtifactRepositories}", readonly = true ) diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java index 1927ee64..879a5b6f 100644 --- a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java +++ b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java @@ -51,8 +51,9 @@ public class EffectiveSiteMojo { /** * Optional parameter to write the output of this help in a given file, instead of writing to the console. - *
+ *

* Note: Could be a relative path. + *

*/ @Parameter( property = "output" ) protected File output; diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java index 191b3ddd..6e46c7d0 100644 --- a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java +++ b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java @@ -34,12 +34,12 @@ import org.codehaus.plexus.util.FileUtils; /** - * Adds the site descriptor (site.xml) to the list of files to be installed/deployed.
- * For Maven-2.x this is enabled by default only when the project has pom packaging since it will be used - * by modules inheriting, but this can be enabled for other projects packaging if needed.
- * This default execution has been removed from the built-in lifecycle of Maven 3.x for pom-projects. + * Adds the site descriptor (site.xml) to the list of files to be installed/deployed. + *

For Maven-2.x this is enabled by default only when the project has pom packaging since it will be + * used by modules inheriting, but this can be enabled for other projects packaging if needed.

+ *

This default execution has been removed from the built-in lifecycle of Maven 3.x for pom-projects. * Users that actually use those projects to provide a common site descriptor for sub modules will need to explicitly - * define this goal execution to restore the intended behavior. + * define this goal execution to restore the intended behavior.

* * @author Brett Porter * diff --git a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java index ccb2efc7..16398c85 100644 --- a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java +++ b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java @@ -128,7 +128,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo * This directory is expected to have the same structure as siteDirectory * (ie. one directory per Doxia-source-supported markup types). * - * @todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source + * todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source * intermediate step? */ @Parameter( alias = "workingDirectory", defaultValue = "${project.build.directory}/generated-site" ) @@ -448,6 +448,13 @@ protected Map> categoriseReports( Collectionreports, *
  • "Project Information" and "Project Reports" category summaries.
  • * + * + * @param context the site context + * @param reports the documents + * @param locale the locale + * @return the documents and their renderers + * @throws IOException in case of file reading issue + * @throws RendererException in case of Doxia rendering issue * @see CategorySummaryDocumentRenderer */ protected Map locateDocuments( SiteRenderingContext context, diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java index 7ff56ac2..f4066d8b 100644 --- a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java +++ b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java @@ -91,11 +91,7 @@ public class SiteMojo private boolean validate; /** - * {@inheritDoc} Generate the project site - *

    - * throws MojoExecutionException if any - * - * @see org.apache.maven.plugin.Mojo#execute() + * {@inheritDoc} */ public void execute() throws MojoExecutionException, MojoFailureException diff --git a/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java b/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java index e9db47b8..792452e3 100644 --- a/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java +++ b/src/main/java/org/apache/maven/plugins/site/run/DoxiaBean.java @@ -39,9 +39,9 @@ public class DoxiaBean private SiteRenderingContext generatedSiteContext; /** - * @param context - * @param documents - * @param generatedSiteDirectory + * @param context context + * @param documents documents + * @param generatedSiteContext context of generated content */ public DoxiaBean( SiteRenderingContext context, Map documents, SiteRenderingContext generatedSiteContext )