javadocs take 42

Author: tballison

.github/scripts/check_javadoc_sourcepath.py

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """
-Guard the hand-maintained <sourcepath> in tika-parent/pom.xml used by the
+Guard the hand-maintained <sourcepath> in the root pom.xml used by the
 TIKA-4318 javadoc:aggregate workaround. That list must name every module's
 src/main/java (except tika-grpc); a module missing from it is silently dropped
 from the aggregated API docs. Run this right before building the javadocs.
@@ -30,7 +30,7 @@
 
 PRUNE = {"target", ".git", ".local_m2_repo", "node_modules", ".mvn"}
 EXCLUDE_MODULE_PREFIX = "tika-grpc/"          # protobuf gen-sources not on the aggregate classpath
-POM = "tika-parent/pom.xml"
+POM = "pom.xml"
 
 
 def actual_roots(root: str):

pom.xml

@@ -304,6 +304,23 @@ least three +1 Tika PMC votes are cast.
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>${maven.javadoc.version}</version>
+        <configuration>
+          <!-- TIKA-4318: javadoc:aggregate only. An explicit multi-root sourcepath forces the
+               plugin onto its legacy (pre-JPMS) -sourcepath code path; without it the plugin runs
+               in modular mode, classifies the reactor modules inconsistently as named vs unnamed,
+               and aborts. This lives in the root pom, which is an aggregator only ; the modules
+               inherit from tika-parent, so this never reaches a per-module javadoc:jar.
+               tika-grpc is excluded: its protobuf generated-sources and compile deps are not on
+               the aggregate classpath. NOTE: keep this list in sync when modules are added or
+               removed; .github/scripts/check_javadoc_sourcepath.py guards it. -->
+          <sourcepath>tika-annotation-processor/src/main/java;tika-app/src/main/java;tika-bundles/tika-bundle-standard/src/main/java;tika-core/src/main/java;tika-detectors/tika-detector-magika/src/main/java;tika-detectors/tika-detector-siegfried/src/main/java;tika-encoding-detectors/tika-encoding-detector-html/src/main/java;tika-encoding-detectors/tika-encoding-detector-icu4j/src/main/java;tika-encoding-detectors/tika-encoding-detector-mojibuster/src/main/java;tika-encoding-detectors/tika-encoding-detector-universal/src/main/java;tika-eval/tika-eval-app/src/main/java;tika-eval/tika-eval-core/src/main/java;tika-example/src/main/java;tika-handlers/tika-handler-boilerpipe/src/main/java;tika-java7/src/main/java;tika-langdetect/tika-langdetect-charsoup-core/src/main/java;tika-langdetect/tika-langdetect-charsoup/src/main/java;tika-langdetect/tika-langdetect-lingo24/src/main/java;tika-langdetect/tika-langdetect-mitll-text/src/main/java;tika-langdetect/tika-langdetect-opennlp/src/main/java;tika-langdetect/tika-langdetect-optimaize/src/main/java;tika-langdetect/tika-langdetect-test-commons/src/main/java;tika-metadata-schema/src/main/java;tika-ml/tika-ml-chardetect/src/main/java;tika-ml/tika-ml-core/src/main/java;tika-ml/tika-ml-junkdetect-tools/src/main/java;tika-ml/tika-ml-junkdetect/src/main/java;tika-parsers/tika-http-jdk/src/main/java;tika-parsers/tika-parsers-extended/tika-parser-ocr-encode-module/src/main/java;tika-parsers/tika-parsers-extended/tika-parser-scientific-module/src/main/java;tika-parsers/tika-parsers-extended/tika-parser-sqlite3-module/src/main/java;tika-parsers/tika-parsers-ml/tika-inference/src/main/java;tika-parsers/tika-parsers-ml/tika-parser-nlp-module/src/main/java;tika-parsers/tika-parsers-ml/tika-parser-tess4j-module/src/main/java;tika-parsers/tika-parsers-ml/tika-transcribe-aws/src/main/java;tika-parsers/tika-parsers-ml/tika-vlm/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-apple-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-cad-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-code-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-crypto-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-datauri-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-font-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-html-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-image-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-jdbc-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-mail-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-mail-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-microsoft-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-miscoffice-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-news-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-pdf-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-pkg-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-webarchive-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-xml-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-xmp-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-zip-commons/src/main/java;tika-pipes/tika-async-cli/src/main/java;tika-pipes/tika-httpclient-commons/src/main/java;tika-pipes/tika-pipes-api/src/main/java;tika-pipes/tika-pipes-config-store-ignite/src/main/java;tika-pipes/tika-pipes-core/src/main/java;tika-pipes/tika-pipes-fork-parser/src/main/java;tika-pipes/tika-pipes-iterator-commons/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-atlassian-jwt/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-az-blob/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-csv/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-es/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-gcs/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-google-drive/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-http/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-jdbc/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-json/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-kafka/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-microsoft-graph/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-opensearch/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-s3/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-solr/src/main/java;tika-pipes/tika-pipes-reporter-commons/src/main/java;tika-plugins-core/src/main/java;tika-serialization/src/main/java;tika-server/tika-server-core/src/main/java;tika-server/tika-server-standard/src/main/java;tika-translate/src/main/java;tika-xmp/src/main/java</sourcepath>
+          <subpackages>org.apache.tika</subpackages>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.apache.rat</groupId>
         <artifactId>apache-rat-plugin</artifactId>

tika-parent/pom.xml

@@ -1715,29 +1715,14 @@
             <version>${maven.javadoc.version}</version>
             <configuration>
               <doclint>none</doclint>
-              <!-- TIKA-4318: an explicit multi-root sourcepath forces the javadoc plugin onto its
-                   legacy (pre-JPMS) -sourcepath code path, so javadoc:aggregate actually produces a
-                   combined report. Tika modules carry Automatic-Module-Name manifest hints but have no
-                   module-info.java; without this, the plugin runs javadoc in modular (module source
-                   path) mode, classifies the reactor modules inconsistently as named vs unnamed, and
-                   javadoc aborts ('aggregated report for both named and unnamed modules is not
-                   possible'). tika-grpc is excluded: its protobuf generated-sources and compile deps
-                   are not on the aggregate classpath. NOTE: keep this list in sync when modules are
-                   added or removed (see TIKA-4318). -->
-              <sourcepath>tika-annotation-processor/src/main/java;tika-app/src/main/java;tika-bundles/tika-bundle-standard/src/main/java;tika-core/src/main/java;tika-detectors/tika-detector-magika/src/main/java;tika-detectors/tika-detector-siegfried/src/main/java;tika-encoding-detectors/tika-encoding-detector-html/src/main/java;tika-encoding-detectors/tika-encoding-detector-icu4j/src/main/java;tika-encoding-detectors/tika-encoding-detector-mojibuster/src/main/java;tika-encoding-detectors/tika-encoding-detector-universal/src/main/java;tika-eval/tika-eval-app/src/main/java;tika-eval/tika-eval-core/src/main/java;tika-example/src/main/java;tika-handlers/tika-handler-boilerpipe/src/main/java;tika-java7/src/main/java;tika-langdetect/tika-langdetect-charsoup-core/src/main/java;tika-langdetect/tika-langdetect-charsoup/src/main/java;tika-langdetect/tika-langdetect-lingo24/src/main/java;tika-langdetect/tika-langdetect-mitll-text/src/main/java;tika-langdetect/tika-langdetect-opennlp/src/main/java;tika-langdetect/tika-langdetect-optimaize/src/main/java;tika-langdetect/tika-langdetect-test-commons/src/main/java;tika-metadata-schema/src/main/java;tika-ml/tika-ml-chardetect/src/main/java;tika-ml/tika-ml-core/src/main/java;tika-ml/tika-ml-junkdetect-tools/src/main/java;tika-ml/tika-ml-junkdetect/src/main/java;tika-parsers/tika-http-jdk/src/main/java;tika-parsers/tika-parsers-extended/tika-parser-ocr-encode-module/src/main/java;tika-parsers/tika-parsers-extended/tika-parser-scientific-module/src/main/java;tika-parsers/tika-parsers-extended/tika-parser-sqlite3-module/src/main/java;tika-parsers/tika-parsers-ml/tika-inference/src/main/java;tika-parsers/tika-parsers-ml/tika-parser-nlp-module/src/main/java;tika-parsers/tika-parsers-ml/tika-parser-tess4j-module/src/main/java;tika-parsers/tika-parsers-ml/tika-transcribe-aws/src/main/java;tika-parsers/tika-parsers-ml/tika-vlm/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-apple-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-cad-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-code-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-crypto-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-datauri-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-digest-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-font-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-html-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-image-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-jdbc-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-mail-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-mail-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-microsoft-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-miscoffice-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-news-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-ocr-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-pdf-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-pkg-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-webarchive-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-xml-module/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-xmp-commons/src/main/java;tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-zip-commons/src/main/java;tika-pipes/tika-async-cli/src/main/java;tika-pipes/tika-httpclient-commons/src/main/java;tika-pipes/tika-pipes-api/src/main/java;tika-pipes/tika-pipes-config-store-ignite/src/main/java;tika-pipes/tika-pipes-core/src/main/java;tika-pipes/tika-pipes-fork-parser/src/main/java;tika-pipes/tika-pipes-iterator-commons/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-atlassian-jwt/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-az-blob/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-csv/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-es/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-gcs/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-google-drive/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-http/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-jdbc/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-json/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-kafka/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-microsoft-graph/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-opensearch/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-s3/src/main/java;tika-pipes/tika-pipes-plugins/tika-pipes-solr/src/main/java;tika-pipes/tika-pipes-reporter-commons/src/main/java;tika-plugins-core/src/main/java;tika-serialization/src/main/java;tika-server/tika-server-core/src/main/java;tika-server/tika-server-standard/src/main/java;tika-translate/src/main/java;tika-xmp/src/main/java</sourcepath>
-              <subpackages>org.apache.tika</subpackages>
+              <!-- Per-module javadoc:jar. Kept at plugin level (not execution level) so a module
+                   with generated sources (tika-grpc) can override it in its own pom. An explicit
+                   sourcepath also forces the plugin onto its legacy (pre-JPMS) code path; without
+                   one it tries to derive module descriptors and fails on jars with broken
+                   automatic modules. The aggregate report's sourcepath lives in the root pom
+                   (TIKA-4318). -->
+              <sourcepath>src/main/java</sourcepath>
             </configuration>
-            <executions>
-              <!-- The aggregate sourcepath above is root-relative, so it resolves to nothing in a
-                   per-module javadoc:jar. Override it for the apache-release parent's
-                   attach-javadocs execution, which documents one module from its own basedir. -->
-              <execution>
-                <id>attach-javadocs</id>
-                <configuration>
-                  <sourcepath>src/main/java</sourcepath>
-                </configuration>
-              </execution>
-            </executions>
           </plugin>
         </plugins>
       </build>