Add markdown support for javadocs and modernize highlighting a bit. #15568
+100
−78
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
github-actions
bot
added
module:analysis
module:test-framework
module:build-infra
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
A feeble attempt at #14257 and perhaps #11870. Allows formatting javadocs as markdown. It also adds prism.js so that code blocks are highlighted using a modern highlighter.
I've converted LuceneTestCase's javadoc as a PoC that it works.
The formatting is done using a custom fork of google-java-format. I've gotten tired of waiting for google/google-java-format#1231 and decided to publish a fork of google-java-format which doesn't break (or touch) markdown javadocs.
Be careful with IDE formatters. If they use the vanilla google-java-format, they may break markdown comments when reflowing longer lines. I don't have a solution for this at the moment; I recommend not caring about code structure until just before pushing the code to github and running tidy beforehand.