Clean up Javadoc

apache · Nov 23, 2024 · 1741219 · 1741219
1 parent 018b294
commit 1741219
Showing 1 changed file with 6 additions and 11 deletions.
diff --git 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 @@ private SiteRenderingContext createSiteRenderingContext(Locale locale)
     /**
      * 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 void generate(Sink sink, Locale locale) throws MavenReportException {
 
     /**
      * 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 @@ protected String getOutputEncoding() {
     }
 
     /**
-     * Gets the locale
+     * Gets the locale.
      *
      * @return the locale for this standalone report
      */