Skip to Main Content

Java Programming

Announcement

For appeals, questions and feedback about Oracle Forums, please email oracle-forums-moderators_us@oracle.com. Technical questions should be asked in the appropriate category. Thank you!

Interested in getting your voice heard by members of the Developer Marketing team at Oracle? Check out this post for AppDev or this post for AI focus group information.

Custom doclets for Javadoc

Hi,

I want to be able to generate a category overview for my Java code and was considering Javadoc as a way to do this.

  • Add a custom block tag @category to my packages, classes, methods etc. (for example @category DESIGN)
  • Render these in the normal Javadoc output with a Taglet
  • Use a custom doclet to find all these tags and produce an HTML doc with subheadings for each category, listing the places where that category is tagged. (ideally with hyperlinks to the main docs)

Does this sound possible?

I think I understand the Doclet interface but it's quite complicated and I expect I'll need a bit of advice. Where do the Javadoc experts hang out?

Thanks.

Comments
Post Details
Added on Nov 21 2024
0 comments
20 views