Add combined javadoc for all subprojects

2024-06-08 17:10:00 +02:00 · 2024-06-08 17:10:00 +02:00 · 7f2eebd595
commit 7f2eebd595
parent 2f0a3f5ab3
3 changed files with 55 additions and 0 deletions
--- a/build.gradle
+++ b/build.gradle
@ -9,6 +9,32 @@ dependencies {
    annotationProcessor 'org.projectlombok:lombok:' + project.dependencyLombok
 }

+tasks.register('javadocAll', Javadoc) {
+    setDescription("Generates Javadoc API documentation for all subprojects.")
+    setGroup("documentation")
+
+    def subprojects= [
+            ':base',
+            ':testapp',
+    ]
+
+    setSource(subprojects.collect { project(it).sourceSets.main.allJava })
+    setClasspath(files(subprojects.collect { project(it).sourceSets.main.compileClasspath }))
+    setDestinationDir(file("build/docs/javadoc"))
+
+    options {
+        setMemberLevel(JavadocMemberLevel.PUBLIC)
+        setOverview("src/main/javadoc/overview.html")
+        setLocale("en_US")
+        setJFlags([
+                // Force Javadoc to use English translations
+                "-Duser.language=en_US"
+        ])
+    }
+
+    dependsOn delombok
+}
+
 allprojects {
    group = project.group
    version = project.versioningVersion + "-" + project.versioningType + project.versioningTyperelease + project.versioningFork
--- a/src/main/javadoc/overview.html
+++ b/src/main/javadoc/overview.html
@ -0,0 +1,24 @@
+<!--
+ STAROPENSOURCE ENGINE SOURCE FILE
+ Copyright (c) 2024 The StarOpenSource Engine Contributors
+ Licensed under the GNU Affero General Public License v3
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as
+ published by the Free Software Foundation, either version 3 of the
+ License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+<body>
+ <p>Welcome to the sos!engine API documentation!<br/>
+  You are currently in the documentation for the core engine and all official subsystems.</p>
+ <p>For a simplified documentation, see <a href="https://engine.staropensource.de">the sos!engine documentation</a>.<br/>
+ For the engine source code, visit <a href="https://git.staropensource.de/StarOpenSource/engine">sos!git</a>.</p>
+</body>
--- a/testapp/src/main/java/de/staropensource/sosengine/testapp/package-info.java
+++ b/testapp/src/main/java/de/staropensource/sosengine/testapp/package-info.java
@ -0,0 +1,5 @@
+/**
+ * Contains the code for the engine development application.
+ * You can always safely ignore everything in this package.
+ */
+package de.staropensource.sosengine.testapp;