From 7f2eebd595405030eb6015e39300b5b2800ac3cd Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 8 Jun 2024 17:10:00 +0200 Subject: [PATCH] Add combined javadoc for all subprojects --- build.gradle | 26 +++++++++++++++++++ src/main/javadoc/overview.html | 24 +++++++++++++++++ .../sosengine/testapp/package-info.java | 5 ++++ 3 files changed, 55 insertions(+) create mode 100644 src/main/javadoc/overview.html create mode 100644 testapp/src/main/java/de/staropensource/sosengine/testapp/package-info.java diff --git a/build.gradle b/build.gradle index b14af4d..3d34f94 100644 --- 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 diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html new file mode 100644 index 0000000..fdf98d4 --- /dev/null +++ b/src/main/javadoc/overview.html @@ -0,0 +1,24 @@ + + +

Welcome to the sos!engine API documentation!
+ You are currently in the documentation for the core engine and all official subsystems.

+

For a simplified documentation, see the sos!engine documentation.
+ For the engine source code, visit sos!git.

+ diff --git a/testapp/src/main/java/de/staropensource/sosengine/testapp/package-info.java b/testapp/src/main/java/de/staropensource/sosengine/testapp/package-info.java new file mode 100644 index 0000000..a84f1f4 --- /dev/null +++ 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;