fix: improve the javadoc generation #642
Open
Conversation
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
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
Comment on lines
12
to
20
| <li><a href="./index.html">core</a> Core classes and interfaces</li> | ||
| <li> | ||
| <a href="../core-proto/index.html">core-protobuf</a> The ProtoBuf wrapper | ||
| classes | ||
| </li> | ||
| <li> | ||
| <a href="../isthmus/index.html">Isthmus API</a> Utility module that uses | ||
| Calcite to convert SQL to/from Substrait | ||
| </li> |
Member
There was a problem hiding this comment.
Suggest adding some extra punctuation between the link title and the description.
Suggested change
| <li><a href="./index.html">core</a> Core classes and interfaces</li> | |
| <li> | |
| <a href="../core-proto/index.html">core-protobuf</a> The ProtoBuf wrapper | |
| classes | |
| </li> | |
| <li> | |
| <a href="../isthmus/index.html">Isthmus API</a> Utility module that uses | |
| Calcite to convert SQL to/from Substrait | |
| </li> | |
| <li><a href="./index.html">core</a> - Core classes and interfaces</li> | |
| <li> | |
| <a href="../core-proto/index.html">core-protobuf</a> - The Protocol Buffers wrapper | |
| classes | |
| </li> | |
| <li> | |
| <a href="../isthmus/index.html">Isthmus API</a> - Utility module that uses | |
| Calcite to convert SQL to/from Substrait | |
| </li> |
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>
mbwhite
force-pushed
the
fix-javadoc-gen
branch
from
3c5cf68 to
fdb782a
Compare
nielspardon
reviewed
Jan 8, 2026
| @@ -0,0 +1,22 @@ | |||
| <body> | |||
Member
There was a problem hiding this comment.
having the overview.html in the repository root feels a bit odd to me and my mind is trying to figure out whether it should be in a subfolder and which one
Member
There was a problem hiding this comment.
Maybe src/main/doc, src/main/javadoc, src/doc? I don't have experience at all with this file here. But just throwing some ideas out. I agree that this shouldn't be at the root level.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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