Update dependencies, publish using GitHub actions and correctly suppo…

…rt inline return tags.

.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: 'Publish'
+on:
+  create:
+    branches:
+      - 'master'
+
+jobs:
+  publish:
+    if: startsWith(github.repository, 'ModdingX/') # don't run in forks
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v4
+      - name: 'Setup Java'
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+      - name: 'Build'
+        run: |
+          ./gradlew \
+          -Pversion=${{ github.ref_name }} \
+          -PmoddingxUsername=${{ secrets.PUBLISH_USER }} \
+          -PmoddingxPassword=${{ secrets.PUBLISH_PASSWORD }} \
+          build publish

build.gradle

@@ -4,17 +4,17 @@ plugins {
 }
 
 group = 'org.moddingx'
-java.toolchain.languageVersion = JavaLanguageVersion.of(17)
+java.toolchain.languageVersion = JavaLanguageVersion.of(21)
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    implementation 'com.google.code.findbugs:jsr305:3.0.2'
-    implementation 'org.apache.commons:commons-text:1.10.0'
-    implementation 'com.google.code.gson:gson:2.10.1'
-    implementation 'org.jsoup:jsoup:1.16.1' 
+    implementation 'org.jetbrains:annotations:24.1.0'
+    implementation 'org.apache.commons:commons-text:1.12.0'
+    implementation 'com.google.code.gson:gson:2.11.0'
+    implementation 'org.jsoup:jsoup:1.17.2' 
 }
 
 task fatjar(type: Jar) {
@@ -60,7 +60,9 @@ publishing {
     }
     repositories {
         maven {
-            url '../moddingx/maven'
+            name 'moddingx'
+            url 'https://maven.moddingx.org/release'
+            credentials(PasswordCredentials)
         }
     }
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,18 +198,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +41,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

src/main/java/org/moddingx/java_doclet_meta/option/PackagesOption.java

@@ -24,7 +24,7 @@ public String getParameters() {
 
     @Override
     public boolean process(String option, List<String> arguments) {
-        this.packages.add(arguments.get(0).replace('/', '.'));
+        this.packages.add(arguments.getFirst().replace('/', '.'));
         return true;
     }
 

src/main/java/org/moddingx/java_doclet_meta/option/PathOption.java

@@ -25,7 +25,7 @@ public String getParameters() {
 
     @Override
     public boolean process(String option, List<String> arguments) {
-        path = Paths.get(arguments.get(0));
+        path = Paths.get(arguments.getFirst());
         return true;
     }
 

src/main/java/org/moddingx/java_doclet_meta/record/DocData.java

@@ -12,6 +12,7 @@
 import javax.lang.model.element.Element;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Stream;
 
 public record DocData(
         String summary,
@@ -38,6 +39,7 @@ public static Optional<DocData> from(DocEnv env, Element element) {
         List<DocBlockData> properties = tree.getBlockTags().stream()
                 .flatMap(tag -> DocBlockData.from(env, DocTreePath.getPath(basePath, tag), tag).stream())
                 .toList();
-        return Optional.of(new DocData(summary, text, properties));
+        List<DocBlockData> inlineProperties = DocBlockData.fromInline(env, basePath, properties, tree.getFullBody());
+        return Optional.of(new DocData(summary, text, Stream.concat(properties.stream(), inlineProperties.stream()).toList()));
     }
 }

src/main/java/org/moddingx/java_doclet_meta/record/FieldData.java

@@ -24,14 +24,12 @@ public JsonObject json() {
         json.add("modifiers", JsonUtil.array(modifiers));
         json.add("type", type.json());
         constant.ifPresent(o -> {
-            if (o instanceof String str) {
-                json.addProperty("constant", str);
-            } else if (o instanceof Number n) {
-                json.addProperty("constant", n);
-            } else if (o instanceof Boolean b) {
-                json.addProperty("constant", b);
-            } else if (o instanceof Character c) {
-                json.addProperty("constant", c);
+            switch (o) {
+                case String str -> json.addProperty("constant", str);
+                case Number n -> json.addProperty("constant", n);
+                case Boolean b -> json.addProperty("constant", b);
+                case Character c -> json.addProperty("constant", c);
+                default -> {}
             }
         });
         doc.ifPresent(d -> json.add("doc", d.json()));

src/main/java/org/moddingx/java_doclet_meta/record/block/ClassTextBlock.java

@@ -3,9 +3,9 @@
 import com.google.gson.JsonObject;
 import com.sun.source.doctree.ReferenceTree;
 import com.sun.source.util.DocTreePath;
+import org.jetbrains.annotations.Nullable;
 import org.moddingx.java_doclet_meta.DocEnv;
 
-import javax.annotation.Nullable;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
 

src/main/java/org/moddingx/java_doclet_meta/record/block/DocBlockData.java

@@ -3,13 +3,14 @@
 import com.google.gson.JsonObject;
 import com.sun.source.doctree.*;
 import com.sun.source.util.DocTreePath;
+import com.sun.source.util.DocTreeScanner;
 import org.moddingx.java_doclet_meta.DocEnv;
 import org.moddingx.java_doclet_meta.util.HtmlConverter;
 
-import java.util.Locale;
-import java.util.Optional;
+import java.util.*;
+import java.util.stream.Collectors;
 
-public interface DocBlockData{
+public sealed interface DocBlockData permits TextBlock, ClassTextBlock {
 
     Type type();
 
@@ -22,6 +23,25 @@ default JsonObject json() {
 
     void addProperties(JsonObject json);
 
+    static List<DocBlockData> fromInline(DocEnv env, DocTreePath basePath, List<DocBlockData> blocks, List<? extends DocTree> inline) {
+        // Inline return tags in the main description should act as separate block tags.
+        Set<DocBlockData.Type> knownTypes = new HashSet<>(blocks.stream().map(DocBlockData::type).collect(Collectors.toUnmodifiableSet()));
+        List<DocBlockData> inlineBlocks = new ArrayList<>();
+
+        DocTreeScanner<Void, Void> scanner = new DocTreeScanner<>() {
+            @Override
+            public Void visitReturn(ReturnTree tree, Void unused) {
+                if (tree.isInline() && knownTypes.add(Type.RETURN)) {
+                    inlineBlocks.add(new TextBlock(Type.RETURN, HtmlConverter.asDocHtml(env, DocTreePath.getPath(basePath, tree), tree.getDescription())));
+                }
+                return super.visitReturn(tree, unused);
+            }
+        };
+
+        scanner.scan(inline, null);
+        return List.copyOf(inlineBlocks);
+    }
+
     static Optional<DocBlockData> from(DocEnv env, DocTreePath path, DocTree tree) {
         // Ignore parameters, they are merged with ParamData
         return Optional.ofNullable(switch (tree.getKind()) {

src/main/java/org/moddingx/java_doclet_meta/util/HtmlConverter.java

@@ -2,9 +2,9 @@
 
 import com.sun.source.doctree.*;
 import com.sun.source.util.DocTreePath;
+import org.jetbrains.annotations.Nullable;
 import org.moddingx.java_doclet_meta.DocEnv;
 
-import javax.annotation.Nullable;
 import javax.lang.model.element.*;
 import java.util.List;
 
@@ -51,6 +51,11 @@ public static String asDocHtml(DocEnv env, @Nullable DocTreePath basePath, List<
                 case VALUE -> sb.append(inlineValue(env, path, ((ValueTree) tree).getReference()));
                 case SYSTEM_PROPERTY -> sb.append("<system_property>").append(HtmlQuote.quote(((SystemPropertyTree) tree).getPropertyName().toString())).append("</system_property>");
                 case IDENTIFIER -> sb.append(HtmlQuote.quote(((IdentifierTree) tree).getName().toString()));
+                case RETURN -> {
+                    if (((ReturnTree) tree).isInline()) {
+                        sb.append(HtmlQuote.quote("Returns ")).append(asDocHtml(env, basePath, ((ReturnTree) tree).getDescription())).append(HtmlQuote.quote("."));
+                    }
+                }
                 case TEXT -> sb.append(HtmlQuote.quote(((TextTree) tree).getBody()));
                 case UNKNOWN_INLINE_TAG -> {
                     UnknownInlineTagTree tag = (UnknownInlineTagTree) tree;