Need to document specific classes/methods for API

Hello everyone,

I am trying to create an API for only those methods or classes which we have agreed to support for customers. Is there a pre-existing tag, taglet, or docloet that will allow me to have javadoc run for only those elements containing a specific tag? It could be any combination of elements in the hierarchy too, half the classes in one package, all in another, none in a third, and anywhere from zero to all the methods in a class.

This is a large codebase, so I can't just exclude the elements I don't need. I'm hoping not to have to create a custom doclet or taglet, but if that's the way to go I would just like confirmation on that from the community.

Thanks everyone

[714 byte] By [sickesa] at [2007-10-3 3:19:10]
# 1

This question appears on this forum about once a month.

Here's the standard answer:

http://web.archive.org/web/20050204060543/java.sun.com/j2se/javadoc/faq/index.html#exclude

(I'm pointing you to the Internet Archives because Sun's Javadoc FAQ was somehow corrupted and returned to a 2-year-old version, without the complete answer.)

-Doug

dhkramera at 2007-7-14 21:11:04 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...
# 2
BTW, if you type "exclude" into the search box of this forum, most of the first ten search hits will give you other threads that discuss this topic.-Doug
dhkramera at 2007-7-14 21:11:04 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...