From 8758dbb85c84ae4252487f34b99d1be9a60b4a45 Mon Sep 17 00:00:00 2001
From: Andreas Dangel <andreas.dangel@pmd-code.org>
Date: Thu, 7 Mar 2024 21:18:00 +0100
Subject: [PATCH] [compat6] Fix javadoc errors

---
 .../java/net/sourceforge/pmd/PMDConfiguration.java   | 12 +++++-------
 .../main/java/net/sourceforge/pmd/PmdAnalysis.java   | 12 ++++++------
 .../src/main/java/net/sourceforge/pmd/Report.java    |  1 -
 .../java/net/sourceforge/pmd/cpd/CSVRenderer.java    |  2 +-
 .../sourceforge/pmd/cpd/renderer/CPDRenderer.java    |  2 +-
 5 files changed, 13 insertions(+), 16 deletions(-)

diff --git a/pmd-compat6/src/main/java/net/sourceforge/pmd/PMDConfiguration.java b/pmd-compat6/src/main/java/net/sourceforge/pmd/PMDConfiguration.java
index 076da233c9..545f848b5b 100644
--- a/pmd-compat6/src/main/java/net/sourceforge/pmd/PMDConfiguration.java
+++ b/pmd-compat6/src/main/java/net/sourceforge/pmd/PMDConfiguration.java
@@ -45,7 +45,7 @@ import net.sourceforge.pmd.util.log.internal.SimpleMessageReporter;
  * PMD run. Once configured, use {@link PmdAnalysis#create(PMDConfiguration)}
  * in a try-with-resources to execute the analysis (see {@link PmdAnalysis}).
  *
- * <h3>Rulesets</h3>
+ * <h2>Rulesets</h2>
  *
  * <ul>
  * <li>You can configure paths to the rulesets to use with {@link #addRuleSet(String)}.
@@ -57,7 +57,7 @@ import net.sourceforge.pmd.util.log.internal.SimpleMessageReporter;
  * be loaded.
  * </ul>
  *
- * <h3>Source files</h3>
+ * <h2>Source files</h2>
  *
  * <ul>
  * <li>The default encoding of source files is the system default as
@@ -72,7 +72,7 @@ import net.sourceforge.pmd.util.log.internal.SimpleMessageReporter;
  * {@link #setForceLanguageVersion(LanguageVersion)}.</li>
  * </ul>
  *
- * <h3>Rendering</h3>
+ * <h2>Rendering</h2>
  *
  * <ul>
  * <li>The renderer format to use for Reports. {@link #getReportFormat()}</li>
@@ -85,7 +85,7 @@ import net.sourceforge.pmd.util.log.internal.SimpleMessageReporter;
  * {@link #isShowSuppressedViolations()}</li>
  * </ul>
  *
- * <h3>Language configuration </h3>
+ * <h2>Language configuration </h2>
  * <ul>
  * <li>Use {@link #setSuppressMarker(String)} to change the comment marker for suppression comments. Defaults to {@value #DEFAULT_SUPPRESS_MARKER}.</li>
  * <li>See {@link #setClassLoader(ClassLoader)} and {@link #prependAuxClasspath(String)} for
@@ -93,7 +93,7 @@ import net.sourceforge.pmd.util.log.internal.SimpleMessageReporter;
  * <li>You can set additional language properties with {@link #getLanguageProperties(Language)}</li>
  * </ul>
  *
- * <h3>Miscellaneous</h3>
+ * <h2>Miscellaneous</h2>
  * <ul>
  * <li>Use {@link #setThreads(int)} to control the parallelism of the analysis. Defaults
  * one thread per available processor. {@link #getThreads()}</li>
@@ -462,7 +462,6 @@ public class PMDConfiguration extends AbstractConfiguration {
      *
      * @return true, if the rule set factory compatibility feature is enabled
      *
-     * @see RuleSetLoader#enableCompatibility(boolean)
      */
     public boolean isRuleSetFactoryCompatibilityEnabled() {
         return ruleSetFactoryCompatibilityEnabled;
@@ -473,7 +472,6 @@ public class PMDConfiguration extends AbstractConfiguration {
      *
      * @param ruleSetFactoryCompatibilityEnabled {@code true} if the feature should be enabled
      *
-     * @see RuleSetLoader#enableCompatibility(boolean)
      */
     public void setRuleSetFactoryCompatibilityEnabled(boolean ruleSetFactoryCompatibilityEnabled) {
         this.ruleSetFactoryCompatibilityEnabled = ruleSetFactoryCompatibilityEnabled;
diff --git a/pmd-compat6/src/main/java/net/sourceforge/pmd/PmdAnalysis.java b/pmd-compat6/src/main/java/net/sourceforge/pmd/PmdAnalysis.java
index a5580cdefb..552b96cc05 100644
--- a/pmd-compat6/src/main/java/net/sourceforge/pmd/PmdAnalysis.java
+++ b/pmd-compat6/src/main/java/net/sourceforge/pmd/PmdAnalysis.java
@@ -63,7 +63,7 @@ import net.sourceforge.pmd.util.log.PmdReporter;
  * Main programmatic API of PMD. This is not a CLI entry point, see module
  * {@code pmd-cli} for that.
  *
- * <h3>Usage overview</h3>
+ * <h2>Usage overview</h2>
  *
  * <p>Create and configure a {@link PMDConfiguration},
  * then use {@link #create(PMDConfiguration)} to obtain an instance.
@@ -71,7 +71,7 @@ import net.sourceforge.pmd.util.log.PmdReporter;
  * files to process, or additional rulesets and renderers. Then, call
  * {@link #performAnalysis()} or one of the related terminal methods.
  *
- * <h3>Simple example</h3>
+ * <h2>Simple example</h2>
  *
  * <pre>{@code
  *   PMDConfiguration config = new PMDConfiguration();
@@ -96,13 +96,13 @@ import net.sourceforge.pmd.util.log.PmdReporter;
  *   }
  * }</pre>
  *
- * <h3>Rendering reports</h3>
+ * <h2>Rendering reports</h2>
  *
  * <p>If you just want to render a report to a file like with the CLI, you
  * should use a {@link Renderer}. You can add a custom one with {@link PmdAnalysis#addRenderer(Renderer)}.
  * You can add one of the builtin renderers from its ID using {@link PMDConfiguration#setReportFormat(String)}.
  *
- * <h3>Reports and events</h3>
+ * <h2>Reports and events</h2>
  *
  * <p>If you want strongly typed access to violations and other analysis events,
  * you can implement and register a {@link GlobalAnalysisListener} with {@link #addListener(GlobalAnalysisListener)}.
@@ -120,12 +120,12 @@ import net.sourceforge.pmd.util.log.PmdReporter;
  *
  * <p>Listeners can be used alongside renderers.
  *
- * <h3>Specifying the Java classpath</h3>
+ * <h2>Specifying the Java classpath</h2>
  *
  * <p>Java rules work better if you specify the path to the compiled classes
  * of the analysed sources. See {@link PMDConfiguration#prependAuxClasspath(String)}.
  *
- * <h3>Customizing message output</h3>
+ * <h2>Customizing message output</h2>
  *
  * <p>The analysis reports messages like meta warnings and errors through a
  * {@link PmdReporter} instance. To override how those messages are output,
diff --git a/pmd-compat6/src/main/java/net/sourceforge/pmd/Report.java b/pmd-compat6/src/main/java/net/sourceforge/pmd/Report.java
index a5eff60bf1..dd5d18e2cc 100644
--- a/pmd-compat6/src/main/java/net/sourceforge/pmd/Report.java
+++ b/pmd-compat6/src/main/java/net/sourceforge/pmd/Report.java
@@ -45,7 +45,6 @@ import net.sourceforge.pmd.util.BaseResultProducingCloseable;
  *     <li>{@link #union(Report)}</li>
  * </ul>
  * These methods create a new {@link Report} rather than modifying their receiver.
- * </p>
  */
 public class Report {
     // todo move to package reporting
diff --git a/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java b/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java
index 0f6b313d3e..366386b1c5 100644
--- a/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java
+++ b/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java
@@ -30,7 +30,7 @@ import net.sourceforge.pmd.lang.document.FileLocation;
  * of fields describing each file where the duplication was found in the format
  * {@code (start line, line count (optional), file path)}. These repeat at least twice.
  *
- * <h3>Examples</h3>
+ * <h2>Examples</h2>
  * <p>
  * Example without {@code lineCountPerFile}:
  * <pre>{@code
diff --git a/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java b/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java
index f79d108642..5776309eba 100644
--- a/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java
+++ b/pmd-compat6/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java
@@ -13,7 +13,7 @@ import java.util.Iterator;
 import net.sourceforge.pmd.cpd.Match;
 
 /**
- * @deprecated Use {@link CPDReportRenderer}
+ * @deprecated Use {@link net.sourceforge.pmd.cpd.CPDReportRenderer}
  */
 @Deprecated
 public interface CPDRenderer {