Hi everyone,
We've been working on a new JavaDoc feature and would love to get some feedback from the community. The feature adds a new standard @note tag for adding rich notes to API documentation and expands the capabilities of custom tags generated by the existing -tag option. Notes can be used as both inline and block tags, and they support attributes to customize their appearance. All the details are described in JEP JDK-8363700: Rich Notes in Java API Documentation[1]. [1]: https://bugs.openjdk.org/browse/JDK-8363700 A fairly mature implementation is available in a GitHub pull request[2]. [2]: https://github.com/openjdk/jdk/pull/28358 There’s also another pull request exploring the use of the new feature in the JDK[3]. A good way to get an understanding of the feature (after reading the JEP of course) is to look at the changes in this PR and then view the output in the uploaded API docs. [3]: https://github.com/openjdk/jdk/pull/31023 We are interested in hearing from you whether the feature, as planned, meets your needs for documenting Java code, and of course whether you think there’s anything we’ve missed or could improve. Please reply to this thread with your thoughts. We look forward to your feedback. Hannes
