Merge branch 'mc-1.20.x' into mc-1.21.x

projects/common-api/build.gradle.kts

@@ -8,6 +8,8 @@ plugins {
     id("cc-tweaked.vanilla")
 }
 
+val mcVersion: String by extra
+
 java {
     withJavadocJar()
 }
@@ -17,8 +19,36 @@ dependencies {
 }
 
 tasks.javadoc {
+    title = "CC: Tweaked $version Minecraft $mcVersion"
     include("dan200/computercraft/api/**/*.java")
 
+    options {
+        (this as StandardJavadocDocletOptions)
+
+        groups = mapOf(
+            "Common" to listOf(
+                "dan200.computercraft.api",
+                "dan200.computercraft.api.lua",
+                "dan200.computercraft.api.peripheral",
+            ),
+            "Upgrades" to listOf(
+                "dan200.computercraft.api.client.turtle",
+                "dan200.computercraft.api.pocket",
+                "dan200.computercraft.api.turtle",
+                "dan200.computercraft.api.upgrades",
+            ),
+        )
+
+        addBooleanOption("-allow-script-in-comments", true)
+        bottom(
+            """
+            <script src="https://cdn.jsdelivr.net/npm/prismjs@v1.29.0/components/prism-core.min.js"></script>
+            <script src="https://cdn.jsdelivr.net/npm/prismjs@v1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
+            <link href=" https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css " rel="stylesheet">
+            """.trimIndent(),
+        )
+    }
+
     // Include the core-api in our javadoc export. This is wrong, but it means we can export a single javadoc dump.
     source(project(":core-api").sourceSets.main.map { it.allJava })
 

projects/common-api/src/main/java/dan200/computercraft/api/ComputerCraftAPI.java

@@ -173,14 +173,14 @@ public final class ComputerCraftAPI {
      * This may be used with {@link IComputerSystem#getComponent(ComputerComponent)} to only attach APIs to specific
      * computers. For example, one can add an additional API just to turtles with the following code:
      *
-     * <pre>{@code
+     * {@snippet lang="java":
      * ComputerCraftAPI.registerAPIFactory(computer -> {
      *   // Read the turtle component.
      *   var turtle = computer.getComponent(ComputerComponents.TURTLE);
      *   // If present then add our API.
      *   return turtle == null ? null : new MyCustomTurtleApi(turtle);
      * });
-     * }</pre>
+     * }
      *
      * @param factory The factory for your API subclass.
      * @see ILuaAPIFactory

projects/common-api/src/main/java/dan200/computercraft/api/network/wired/WiredElement.java

@@ -14,7 +14,7 @@ import dan200.computercraft.api.ComputerCraftAPI;
  * as a proxy for all network objects. Whilst the node may change networks, an element's node should remain constant
  * for its lifespan.
  * <p>
- * Elements are generally tied to a block or tile entity in world. In such as case, one should provide the
+ * Elements are generally tied to a block or block entity in world. In such as case, one should provide the
  * {@link WiredElement} capability for the appropriate sides.
  */
 public interface WiredElement extends WiredSender {