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

[Max Rydahl Andersen]

the "standard" eclipse API tools uses are shown here:

http://209.85.229.132/search?q=cache:WPQKQwm0Hf0J:help.eclipse.org/stable/topic/org.eclipse.pde.doc.user/reference/api-tooling/api_javadoc_tags.htm+Defining+API+Restrictions&cd=1&hl=da&ct=clnk

sorry couldn't find a better public link, but for those who got Eclipse 
installed Press F1 and search for "api tools"

	Class 	Interface 	Method 	Constructor 	

Final Field

	Non-Final Field
@noimplement
	
-
	
Supported
	
-
	
-
	
-
	
-
@noextend
	
Supported
	
Supported
	
-
	
-
	
-
	
-
@noinstantiate
	
Supported
	
-
	
-
	
-
	
-
	
-
@nooverride
	
-
	
-
	
Supported
	
-
	
-
	
-
@noreference
	
-
	
-
	
Supported
	
Supported
	
-
	
Supported


        Restriction Semantics

@noimplement
	

Indicates that clients must not implement this interface. Any class 
using the /implements/ keyword for the associated interface or parent of 
the associated interface where there is no implementing superclass will 
be flagged with problem.

@noextend
	
Indicates that clients must not extend this class or interface. Any 
class or interface using the /extends/ keyword for the associated type 
will be flagged with a problem.
@noinstantiate
	
Indicates that clients must not instantiate this class. Any code that 
instantiates the associated class with any constructor will be flagged 
with a problem.
@nooverride
	
Indicates that clients must not redeclare this method. Any subclass that 
defines a method that overrides the associated method will be flagged 
with a problem.
@noreference
	Indicates that clients must not reference this method, constructor, or 
non-final field. Any code that directly invokes the associated method or 
constructor or references the associated non-final field will be flagged 
with a problem.


/max

Max Rydahl Andersen wrote:
>>> 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
> _______________________________________________
> jboss-development mailing list
> jboss-development at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/jboss-development