You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2024/11/23 14:52:54 UTC
(maven-reporting-impl) branch MCHANGES-436 created (now 1741219)
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a change to branch MCHANGES-436
in repository https://gitbox.apache.org/repos/asf/maven-reporting-impl.git
at 1741219 Clean up Javadoc
This branch includes the following new commits:
new 1741219 Clean up Javadoc
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven-reporting-impl) 01/01: Clean up Javadoc
Posted by el...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch MCHANGES-436
in repository https://gitbox.apache.org/repos/asf/maven-reporting-impl.git
commit 17412192a20c225a794bc7491a64ac62af1340c3
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Sat Nov 23 09:52:45 2024 -0500
Clean up Javadoc
---
.../org/apache/maven/reporting/AbstractMavenReport.java | 17 ++++++-----------
1 file changed, 6 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java b/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
index 2001157..c211c99 100644
--- a/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
+++ b/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
@@ -86,7 +86,7 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
*<p>
* A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional
* user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the
- * main output file (entry point) denoted by {@link #getOutputName()}.
+ * main output file (entry point) denoted by {@link #getOutputPath}.
*/
@Parameter(defaultValue = "${project.build.directory}/reports", required = true)
protected File outputDirectory;
@@ -140,10 +140,10 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
protected File siteDirectory;
/**
- * The locale to use when the report generation is invoked directly as a standalone Mojo.
+ * The locale to use when the report generation is invoked directly as a standalone Mojo.
*
* @see SiteTool#DEFAULT_LOCALE
- * @see SiteTool#getSiteLocales(String)
+ * @see SiteTool#getSiteLocales
*/
@Parameter(defaultValue = "default")
protected String locale;
@@ -331,8 +331,8 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
/**
* Generate a report.
*
- * @param sink the sink to use for the generation.
- * @param locale the wanted locale to generate the report, could be null.
+ * @param sink the sink to use for the generation
+ * @param locale the wanted locale to generate the report, could be null
* @throws MavenReportException if any
* @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.
*/
@@ -344,11 +344,6 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
/**
* This method is called when the report generation is invoked by maven-site-plugin.
- *
- * @param sink
- * @param sinkFactory
- * @param locale
- * @throws MavenReportException
*/
@Override
public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException {
@@ -413,7 +408,7 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
}
/**
- * Gets the locale
+ * Gets the locale.
*
* @return the locale for this standalone report
*/