dweiss opened a new pull request, #15568: URL: https://github.com/apache/lucene/pull/15568
A feeble attempt at #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 https://github.com/google/google-java-format/pull/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. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
