Skip to content

Commit

Permalink
fix javadoc issues with JDK 8
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy committed Jun 21, 2020
1 parent 963cbcb commit d4160ab
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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()
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* <br/>
* <p>
* <b>Note</b>: Could be a relative path.
* </p>
*/
@Parameter( property = "output" )
protected File output;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@
import org.codehaus.plexus.util.FileUtils;

/**
* Adds the site descriptor (<code>site.xml</code>) to the list of files to be installed/deployed.<br/>
* For Maven-2.x this is enabled by default only when the project has <code>pom</code> packaging since it will be used
* by modules inheriting, but this can be enabled for other projects packaging if needed.<br/>
* This default execution has been removed from the built-in lifecycle of Maven 3.x for <code>pom</code>-projects.
* Adds the site descriptor (<code>site.xml</code>) to the list of files to be installed/deployed.
* <p>For Maven-2.x this is enabled by default only when the project has <code>pom</code> packaging since it will be
* used by modules inheriting, but this can be enabled for other projects packaging if needed.</p>
* <p>This default execution has been removed from the built-in lifecycle of Maven 3.x for <code>pom</code>-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.</p>
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
* This directory is expected to have the same structure as <code>siteDirectory</code>
* (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" )
Expand Down Expand Up @@ -448,6 +448,13 @@ protected Map<String, List<MavenReport>> categoriseReports( Collection<MavenRepo
* <li>reports,</li>
* <li>"Project Information" and "Project Reports" category summaries.</li>
* </ul>
*
* @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<String, DocumentRenderer> locateDocuments( SiteRenderingContext context,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,7 @@ public class SiteMojo
private boolean validate;

/**
* {@inheritDoc} Generate the project site
* <p/>
* throws MojoExecutionException if any
*
* @see org.apache.maven.plugin.Mojo#execute()
* {@inheritDoc}
*/
public void execute()
throws MojoExecutionException, MojoFailureException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String, DocumentRenderer> documents,
SiteRenderingContext generatedSiteContext )
Expand Down

0 comments on commit d4160ab

Please sign in to comment.