fix: improve the javadoc generation#642
Open
mbwhite wants to merge 8 commits intosubstrait-io:mainfrom
Open
Conversation
mbwhite
force-pushed
the
fix-javadoc-gen
branch
2 times, most recently
from
7c32998 to
ea78d5c
Compare
nielspardon
requested review from
andrew-coleman,
benbellick,
bestbeforetoday and
vbarua
nielspardon
reviewed
Jan 5, 2026
examples/substrait-spark/src/main/java/io/substrait/examples/util/SubstraitStringify.java
Show resolved
Hide resolved
nielspardon
reviewed
Jan 5, 2026
examples/substrait-spark/src/main/java/io/substrait/examples/util/SubstraitStringify.java
Outdated
Show resolved
Hide resolved
mbwhite
force-pushed
the
fix-javadoc-gen
branch
2 times, most recently
from
aa66f53 to
3c5cf68
Compare
mbwhite
force-pushed
the
fix-javadoc-gen
branch
from
3c5cf68 to
fdb782a
Compare
nielspardon
reviewed
Jan 8, 2026
mbwhite
force-pushed
the
fix-javadoc-gen
branch
from
11c6fa5 to
13b4ed9
Compare
mbwhite
force-pushed
the
fix-javadoc-gen
branch
2 times, most recently
from
bd4e0e9 to
d66c27e
Compare
Contributor
Author
|
@nielspardon @andrew-coleman @benbellick @bestbeforetoday @vbarua I've updated the merge conflicts; if there aren't any more urgent comments on this one... would it be ok to merge please? Help ro reduce any conflicts with other JavaDoc changes. Also this one helps to reduce the overall 'noise' level from the generated protobuf's javadoc. Thanks |
nielspardon
reviewed
Jan 19, 2026
nielspardon
reviewed
Jan 19, 2026
nielspardon
reviewed
Jan 19, 2026
nielspardon
reviewed
Jan 19, 2026
Make all components put javadoc into a consistent root. This achieves the following - means the javadoc for the generated protobuf can be kept quiet - as we can't adjust the javadoc here - there is a single place for javadoc that could be published - the isthmus and core and protobuf projects can be interlinked - isthmus can be linked with the calcite javadoc - overview pages can be added - all under a versioned directory for easy maintence To date there isn't (AFAIK) a stightforward maintainable way to merge javadoc form multi-component projects Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
mbwhite
force-pushed
the
fix-javadoc-gen
branch
2 times, most recently
from
c7b5824 to
5abcd50
Compare
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
mbwhite
force-pushed
the
fix-javadoc-gen
branch
from
5abcd50 to
776b5d8
Compare
nielspardon
reviewed
Jan 23, 2026
| tasks.named<Jar>("javadocJar") { | ||
| val shared = rootProject.layout.buildDirectory.dir("docs/${version}").get().asFile | ||
| if (!shared.exists()) { | ||
| println("Creating a dir for javadoc ${rootProject.buildDir}/docs/${version}") |
Member
There was a problem hiding this comment.
I've seen a deprecation warning for the usebuildDir when I ran this locally. seems one should use layout.buildDirectory.get() instead.
nielspardon
reviewed
Jan 23, 2026
| tasks.named<Jar>("javadocJar") { | ||
| val shared = rootProject.layout.buildDirectory.dir("docs/${version}").get().asFile | ||
| if (!shared.exists()) { | ||
| println("Creating a dir for javadoc ${rootProject.buildDir}/${version}") |
Member
There was a problem hiding this comment.
I've seen a deprecation warning for the usebuildDir when I ran this locally. seems one should use layout.buildDirectory.get() instead.
nielspardon
reviewed
Jan 23, 2026
|
|
||
| // Only the generated proto sources | ||
| setSource(fileTree(protoJavaDir) { include("**/*.java") }) | ||
| // source(fileTree(immuteableJavaDir) { include("**/*.java") }) |
Member
There was a problem hiding this comment.
I guess this line is not really needed
Suggested change
| // source(fileTree(immuteableJavaDir) { include("**/*.java") }) |
nielspardon
reviewed
Jan 23, 2026
|
|
||
| // Only the generated proto sources | ||
| setSource(fileTree(immuteableJavaDir) { include("**/*.java") }) | ||
| // source(fileTree(immuteableJavaDir) { include("**/*.java") }) |
Member
There was a problem hiding this comment.
Suggested change
| // source(fileTree(immuteableJavaDir) { include("**/*.java") }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make all components put javadoc into a consistent root. This achieves the following
To date there isn't (AFAIK) a stightforward maintainable way to merge javadoc form multi-component projects