Skip to content

Conversation

@mbwhite
Copy link
Contributor

@mbwhite mbwhite commented Dec 17, 2025

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

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant