[jboss-dev] building the documentation for JBoss public and private API...

Max Rydahl Andersen max.andersen at redhat.com
Tue Jun 2 13:22:51 EDT 2009


>>
>> One thing I also have for Remoting 3 is a set of javadoc tags that I 
>> can stick on a class or interface which causes a generic explanation 
>> to be appended to the javadoc (like "This interface is intended to be 
>> implemented by the end user" or "This interface is intended for 
>> service providers, so new methods may be added without notice", 
>> etc).  I can provide a link as soon as I get around to getting the 
>> javadoc published for 3.1. 
>
> The advantage though of an annotation, is that we can then generate a 
> compendium of all public apis for all of our software. You can't do 
> that with a note in the javadoc. 

doclets can process javadoc tags...

/max



More information about the jboss-development mailing list