Repository navigation
Published Javadocs for Java Driver 4.x are incomplete #157
Description
Activity
- added a commit that references this issue
on Feb 22, 2023 Partly fixed, and the remaining half is now precisely diagnosable.
f117e2b896addedquery-builderandmapper-runtimeto the copy step, so the class pages
themselves are published — theQueryBuilder404 in the description is gone on any branch
carrying that commit. (scylla-4.xnever got the forward-port; #1118 fixes that.)What is still broken is everything that reaches those classes.
docs/_utils/javadoc.sh
runsjavadoconce per module and overlays the three trees withcp -an, so every file the
modules generate in common keeps core's copy:index-all.html,allclasses-index.html,
overview-tree.html,element-list, and the four*-search-index.jsfiles. Measured on a
freshly built tree:index-all.html QueryBuilder=0 EntityHelper=0 CqlSession=32 allclasses-index.html QueryBuilder=0 EntityHelper=0 CqlSession=8 element-list QueryBuilder=0 EntityHelper=0 CqlSession=0 type-search-index.js QueryBuilder=0 EntityHelper=0 CqlSession=1So the javadoc search box and "All Classes" return nothing for two of the three published
modules, andelement-listlisting only core's packages breaks any external javadoc that
-links against this URL. Theindex-all.htmlthis issue links to is still the right page
to look at.The fix is one javadoc invocation covering the three modules (
javadoc:aggregate, or
includeDependencySources) rather than three separate runs overlaid — a real change to how
the docs are built, not a tweak to the copy step.
https://java-driver.docs.scylladb.com/scylla-4.13.0.x/api/index-all.html
The generated Javadocs don't contain classes from non-core modules, like "query-builder" submodule. This leads to 404 errors, for example on https://java-driver.docs.scylladb.com/stable/manual/query_builder/insert/index.html
QueryBuilderlink leads to nonexistent https://java-driver.docs.scylladb.com/scylla-4.13.0.x/api/com/datastax/oss/driver/api/querybuilder/QueryBuilder.htmlThis problem does not affect Java Driver 3.x branch.