Javadoc improvements

rife2 · Aug 26, 2024 · 28e5489 · 28e5489
1 parent f15a8d2
commit 28e5489
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 11 deletions.
diff --git a/core b/core
diff --git a/src/bld/java/rife/BldBuild.java b/src/bld/java/rife/BldBuild.java
@@ -79,7 +79,10 @@ public BldBuild()
             .sourceFiles(FileUtils.getJavaFileList(core_src_main_java_dir))
             .javadocOptions()
                 .docTitle("<a href=\"https://rife2.com/bld\">bld</a> " + version())
-                .overview(new File(srcMainJavaDirectory(), "overview.html"));
+                .overview(new File(srcMainJavaDirectory(), "overview.html"))
+                .addAll(List.of("--allow-script-in-comments",
+                    "-group", "bld", "rife.bld*",
+                    "-group", "RIFE2/core", "rife:rife.cmf*:rife.config*:rife.database*:rife.datastructures*:rife.engine*:rife.forms*:rife.instrument*:rife.ioc*:rife.resources*:rife.selector*:rife.template*:rife.tools*:rife.validation*:rife.xml*"));
 
         publishOperation()
             .repository(version.isSnapshot() ? repository("rife2-snapshots") : repository("rife2-releases"))
@@ -109,14 +112,6 @@ public BldBuild()
                 new PublishArtifact(zipBldOperation.destinationFile(), "", "zip"));
     }
 
-    @Override
-    public void javadoc()
-    throws Exception {
-        javadocOperation().executeOnce(() -> javadocOperation()
-            .fromProject(this)
-            .sourceFiles(FileUtils.getJavaFileList(buildGeneratedDir)));
-    }
-
     final ZipOperation zipBldOperation = new ZipOperation();
     @BuildCommand(value = "zip-bld", summary = "Creates the bld zip archive")
     public void zipBld()

diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -1,7 +1,10 @@
 /**
  * bld is a new build system that allows you to write your build logic in pure Java.
  * <p>
- * More information can be found on the <a href="https://rife2.com/bld">`bld` website</a>.
+ * More information can be found on the <a href="https://rife2.com/bld"><code>bld</code> website</a>.
+ * <p>
+ * Note that bld builds on top of the foundation that RIFE2 provides and includes the features
+ * of <a href="https://github.com/rife2/rife2-core">RIFE2/core</a>.
  *
  * @since 2.1.0
  */
@@ -19,6 +22,7 @@
     exports rife.bld.dependencies;
     exports rife.bld.dependencies.exceptions;
     exports rife.bld.help;
+    exports rife.bld.instrument;
     exports rife.bld.operations;
     exports rife.bld.operations.exceptions;
     exports rife.bld.publish;

diff --git a/src/main/java/overview.html b/src/main/java/overview.html
@@ -0,0 +1,24 @@
+<html>
+<body>
+<p><code>bld</code> is a new build system that allows you to write your build logic in pure Java.</p>
+
+<p><code>bld</code>'s website is <a href="https://rife2.com/bld">https://rife2.com/bld</a>.</p>
+<p>The GitHub project is at <a href="https://github.com/rife2/bld">https://github.com/rife2/bld</a></p>
+<p>The documentation is available at <a href="https://github.com/rife2/bld/wiki">https://github.com/rife2/bld/wiki</a></p>
+
+<p>Note that bld builds on top of the foundation that RIFE2 provides and includes the features of
+  <a href="https://github.com/rife2/rife2-core">RIFE2/core</a>.</p>
+
+<script type="text/javascript">
+  window.onload = function () {
+    show('all-packages-table', 'all-packages-table-tab1', 2);
+  };
+</script>
+<style>
+  #all-packages-table-tab0 {
+    display: none;
+  }
+</style>
+
+</body>
+</html>
diff --git a/src/main/java/rife/bld/instrument/package-info.java b/src/main/java/rife/bld/instrument/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * Copyright 2001-2024 Geert Bevin (gbevin[remove] at uwyn dot com)
+ * Licensed under the Apache License, Version 2.0 (the "License")
+ */
+
+/**
+ * Provides functionalities for bytecode instrumentation.
+ * @since 2.1
+ */
+package rife.bld.instrument;
+2 −2		.idea/libraries/bld.xml
+ −		lib/bld/bld-wrapper.jar
+1 −1		lib/bld/bld-wrapper.properties
+10 −0		src/bld/java/rife/AbstractRife2Build.java
+0 −9		src/bld/java/rife/CoreBuild.java