Clean up javadoc warnings

EngineHub · Apr 2, 2024 · 475676a · 475676a
1 parent 0b0f052
commit 475676a
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 7 deletions.
diff --git a/buildSrc/src/main/kotlin/CommonJavaConfig.kt b/buildSrc/src/main/kotlin/CommonJavaConfig.kt
@@ -54,7 +54,9 @@ fun Project.applyCommonJavaConfiguration(sourcesJar: Boolean, javaRelease: Int =
     tasks.withType<Javadoc>().configureEach {
         options.encoding = "UTF-8"
         (options as StandardJavadocDocletOptions).apply {
-            addStringOption("Xdoclint:none", "-quiet")
+            addBooleanOption("Werror", true)
+            addBooleanOption("Xdoclint:all", true)
+            addBooleanOption("Xdoclint:-missing", true)
             tags(
                 "apiNote:a:API Note:",
                 "implSpec:a:Implementation Requirements:",

diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/event/extent/EditSessionEvent.java b/worldedit-core/src/main/java/com/sk89q/worldedit/event/extent/EditSessionEvent.java
@@ -38,7 +38,7 @@
 /**
  * Raised (several times) when a new {@link EditSession} is being instantiated.
  *
- * <p></p>Block loggers, as well as block set interceptors, can use this event to wrap
+ * <p>Block loggers, as well as block set interceptors, can use this event to wrap
  * the given {@link Extent} with their own, which would allow them to intercept
  * all changes made to the world. For example, the code below would wrap the
  * existing extent with a custom one, and the custom extent would receive
@@ -49,7 +49,7 @@
  * event.setExtent(new MyExtent(event.getExtent())
  * </pre>
  *
- * <p></p>This event is fired several times during the creation of a single
+ * <p>This event is fired several times during the creation of a single
  * {@link EditSession}, but {@link #getStage()} will differ each time.
  * The stage determines at which point {@link Extent}s added to this event
  * will be called. For example, if you inject an extent when the stage

diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/platform/PlatformManager.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/platform/PlatformManager.java
@@ -308,7 +308,7 @@ public Collection<SideEffect> getSupportedSideEffects() {
 
     /**
      * Get the initialized state of the Platform.
-     * {@return if the platform manager is initialized}
+     * @return if the platform manager is initialized
      */
     public boolean isInitialized() {
         return initialized.get();

diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/internal/annotation/Chunk3d.java b/worldedit-core/src/main/java/com/sk89q/worldedit/internal/annotation/Chunk3d.java
@@ -30,7 +30,7 @@
  * Indicates that this value is for 3d-chunk compatibility.
  *
  * <p>
- * For vectors, this means that the vector supports 2D & 3D inputs,
+ * For vectors, this means that the vector supports 2D &amp; 3D inputs,
  * with 2D getting a Y value of 0.
  * </p>
  */

diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/util/net/HttpRequest.java b/worldedit-core/src/main/java/com/sk89q/worldedit/util/net/HttpRequest.java
@@ -125,7 +125,7 @@ public HttpRequest header(String key, String value) {
 
     /**
      * Execute the request.
-     * <p/>
+     * <p>
      * After execution, {@link #close()} should be called.
      *
      * @return this object

diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/util/time/FileNameDateTimeParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/util/time/FileNameDateTimeParser.java
@@ -52,7 +52,6 @@
  *     <li>{@code 2019-06-15-10-20-30}</li>
  *     <li>{@code 2019-6-1-1-2-3}</li>
  * </ul>
- * </p>
  */
 public class FileNameDateTimeParser implements SnapshotDateTimeParser {