From 113e05b7e6802d216b94d586675ba8df7a6a63d8 Mon Sep 17 00:00:00 2001
From: Raven Szewczyk <git@eigenraven.me>
Date: Mon, 27 Feb 2023 17:30:57 +0000
Subject: [PATCH] Java11 javadoc generator (#18)

---
 .github/workflows/pages.yml                   | 47 -------------------
 .github/workflows/publish-javadoc.yaml        | 11 +++--
 addon.gradle                                  |  7 +++
 .../structure/StructureUtility.java           | 30 ++++++------
 src/main/javadoc/overview.html                |  4 +-
 5 files changed, 31 insertions(+), 68 deletions(-)
 delete mode 100644 .github/workflows/pages.yml

diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
deleted file mode 100644
index a204c39c..00000000
--- a/.github/workflows/pages.yml
+++ /dev/null
@@ -1,47 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["gh-pages"]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow one concurrent deployment
-concurrency:
-  group: "pages"
-  cancel-in-progress: true
-
-jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Pages
-        uses: actions/configure-pages@v2
-      - name: Generate Index
-        shell: bash
-        run: |
-          find . -name javadoc -type d -print > index.txt
-          echo feature/doc >> index.txt
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload entire repository
-          path: '.'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v1
diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml
index 0196d82f..cd635557 100644
--- a/.github/workflows/publish-javadoc.yaml
+++ b/.github/workflows/publish-javadoc.yaml
@@ -20,13 +20,16 @@ jobs:
     outputs:
       result_hash: ${{ steps.deploy.outputs.hash }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
-          java-version: 8
+          java-version: |
+            8
+            11
+            17
           distribution: 'temurin'
           cache: gradle
 
@@ -51,7 +54,7 @@ jobs:
             echo Nothing to deploy
             exit 0
           fi
-          find . -name javadoc -type d -print | sed 's#^\./\(.*\)/javadoc$#\1#' > index.txt
+          find . -name javadoc -type d -print | sed 's#^\./\(.*\)/javadoc$#\1#' | sort --version-sort --reverse > index.txt
           git add index.txt
           git config user.name "${GITHUB_ACTOR}"
           git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
diff --git a/addon.gradle b/addon.gradle
index 35a01be0..32cd6394 100644
--- a/addon.gradle
+++ b/addon.gradle
@@ -1,4 +1,10 @@
 javadoc {
+    javadocTool = javaToolchains.javadocToolFor {
+        // Last version with frames, but it also has search
+        languageVersion = JavaLanguageVersion.of(11)
+        vendor = JvmVendorSpec.ADOPTIUM
+    }
+
     inputs.file  "src/main/javadoc/overview.html"
 
     include "com/gtnewhorizon/structurelib/alignment/**"
@@ -14,6 +20,7 @@ javadoc {
         overview "src/main/javadoc/overview.html"
         links 'https://docs.oracle.com/javase/8/docs/api/'
         links 'https://skmedix.github.io/ForgeJavaDocs/javadoc/forge/1.7.10-10.13.4.1614/'
+        addBooleanOption("-frames", true)
     }
 }
 
diff --git a/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java b/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java
index 460a2849..f8392660 100644
--- a/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java
+++ b/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java
@@ -42,54 +42,54 @@ import cpw.mods.fml.common.registry.GameRegistry;
 
 /**
  * A brief index of everything contained
- * <h1>Control blocks</h1> A lot of these might seem to make more sense as a default function on
+ * <h2>Control blocks</h2> A lot of these might seem to make more sense as a default function on
  * {@link IStructureElement}. However, in that case javac generic will often fail to infer the type for you, so we have
  * to define them as static methods
- * <h1>If block</h1> Provide if block, allowing downstream call only if user specified conditions are meet (i.e.
+ * <h2>If block</h2> Provide if block, allowing downstream call only if user specified conditions are meet (i.e.
  * predicate returns true)
  * <ul>
  * <li>{@link #onlyIf(Predicate, IStructureElement)} and its overloads</li>
  * </ul>
- * <h1>Switch block</h1> Provide switch block, allowing to select a downstream element by using a key or index computed
+ * <h2>Switch block</h2> Provide switch block, allowing to select a downstream element by using a key or index computed
  * from trigger item and/or context object.
  * <ul>
  * <li>{@link #partitionBy(Function, IStructureElement[])} and its overloads</li>
  * </ul>
- * <h1>Or Chain</h1> Provide a short-circuiting OR chain.
+ * <h2>Or Chain</h2> Provide a short-circuiting OR chain.
  * <ul>
  * <li>{@link #ofChain(IStructureElement[])} and its overloads</li>
  * </ul>
- * <h2>Side effect</h2> Provide callbacks on various occasion
+ * <h3>Side effect</h3> Provide callbacks on various occasion
  * <ul>
  * <li>{@link #onElementPass(Consumer, IStructureElement)}: Call an callback upon element check success</li>
  * <li>{@link #onElementFail(Consumer, IStructureElement)}: Call an callback upon element check failure</li>
  * </ul>
  *
- * <h1>Other Primitives</h1>
- * <h2>Error statement</h2> Unconditionally return false.
+ * <h2>Other Primitives</h2>
+ * <h3>Error statement</h3> Unconditionally return false.
  * <ul>
  * <li>{@link #error()}</li>
  * </ul>
- * <h2>Context Object Change</h2> Switch the context object.
+ * <h3>Context Object Change</h3> Switch the context object.
  * <ul>
  * <li>{@link #withContext(IStructureElement)}: switch context to the extended context</li>
  * </ul>
- * <h2>Channel Change</h2> Change the channel. See <a href="{@docRoot}/overview-summary.html#channels">Channels section
+ * <h3>Channel Change</h3> Change the channel. See <a href="{@docRoot}/overview-summary.html#channels">Channels section
  * on overview</a> for more information.
  * <ul>
  * <li>{@link #withChannel(String, IStructureElement)}: switch channel using
  * {@link ChannelDataAccessor#withChannel(ItemStack, String)} when a trigger item is present.</li>
  * </ul>
- * <h2>Spawn hint particle</h2> Just spawn a hint. Do nothing otherwise. Useful when you want to override the hint
+ * <h3>Spawn hint particle</h3> Just spawn a hint. Do nothing otherwise. Useful when you want to override the hint
  * provided by another structure element, or as a fallback to a structure element that is check only.
  * <ul>
  * <li>{@link #ofHint(int)}, {@link #ofHintDeferred(Supplier)} and its overloads</li>
  * </ul>
  *
- * <h1>Actual Element</h1> These elements are elements that can actually do structure check, spawn hint and do auto
+ * <h2>Actual Element</h2> These elements are elements that can actually do structure check, spawn hint and do auto
  * place. Elements listed in above 2 sections are not going to be helpful without elements like these. They also serve
  * as a reference implementation for your own custom {@link IStructureElement} implementations.
- * <h2>Simple Block Element</h2> These accept one or more different block types in one location.
+ * <h3>Simple Block Element</h3> These accept one or more different block types in one location.
  * <ul>
  * <li>{@link #ofBlock(Block, int, Block, int)}, {@link #ofBlocksFlat(Map, Block, int)},
  * {@link #ofBlocksMap(Map, Block, int)} and their overloads: the most basic form</li>
@@ -98,7 +98,7 @@ import cpw.mods.fml.common.registry.GameRegistry;
  * <li>{@link #isAir()}, {@link #notAir()}: They are supplied by default under the identifier {@code '-'} and
  * {@code '+'} respectively, but are provided here regardless in case you want to use them as a fallback.</li>
  * </ul>
- * <h2>Complex Block Element</h2> In case your logic on determining which block is accepted is complex, use these.
+ * <h3>Complex Block Element</h3> In case your logic on determining which block is accepted is complex, use these.
  * <ul>
  * <li>{@link #ofBlockAdder(IBlockAdder, Block, int)}, {@link #ofBlockAdderHint(IBlockAdder, Block, int)} and their
  * overloads: hands off actual adder logic to an {@link IBlockAdder} you supplied. Save you the boilerplate of querying
@@ -110,7 +110,7 @@ import cpw.mods.fml.common.registry.GameRegistry;
  * Similar to block adder, but for tile entities.</li>
  * </ul>
  *
- * <h1>Helper Methods</h1> These don't construct a {@link IStructureElement}, but is helpful to the instantiation or
+ * <h2>Helper Methods</h2> These don't construct a {@link IStructureElement}, but is helpful to the instantiation or
  * implementation of these.
  * <ul>
  * <li>{@link #survivalPlaceBlock(Block, int, World, int, int, int, IItemSource, EntityPlayer, Consumer)} and its
@@ -595,7 +595,7 @@ public class StructureUtility {
      * <b>Example:</b>
      * <p>
      * Assume you have 16 tier, each map to one block's 16 different meta. You will usually want something like this
-     * 
+     *
      * <pre>
      * public class Tile extends TileEntity {
      *     private static final Block B = getTargetBlock();
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
index 941f0e84..96c47577 100644
--- a/src/main/javadoc/overview.html
+++ b/src/main/javadoc/overview.html
@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!DOCTYPE html>
 <HTML>
 <HEAD>
     <TITLE>API Overview</TITLE>
@@ -219,7 +219,7 @@ whereas all these structure elements are designed without considering channels w
 <pre>
 import com.gtnewhorizon.structurelib.structure.IStructureElement;
 
-public class MyHatchElement&lt;T> implements IStructureElement&lt;T> {
+public class MyHatchElement&lt;T&gt; implements IStructureElement&lt;T&gt; {
     //...
    {@literal @}Override
     public PlaceResult survivalPlaceBlock(