ch.ralscha.extdirectspring.annotation

Annotation Type ExtDirectMethodDocumentation

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface ExtDirectMethodDocumentation

These are only used for api-debug-doc.js generation to self documents the client server interface.

see example above

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	author (Optional) method author add a @author to the method currently documented Defaults to empty.
boolean	deprecated (Optional) Whether this method is deprecated add a @deprecated to the method currently documented Defaults to false.
ExtDirectDocParameters	parameters (Optional) Parameters documentation that are to be placed on the api method.
ExtDirectDocReturn	returnMethod (Optional) objects to be returned when this method is called Defaults to no return.
String	value (Optional) the method comment if method description is empty, the documentation for this method will be skipped
String	version (Optional) method version add a @version to the method currently documented Defaults to 1.0.

Element Detail

value

public abstract String value

(Optional) the method comment if method description is empty, the documentation for this method will be skipped

Default:

""

author

public abstract String author

(Optional) method author

add a @author to the method currently documented

Defaults to empty.

Default:

""

version

public abstract String version

(Optional) method version

add a @version to the method currently documented

Defaults to 1.0.

Default:

"1.0"

parameters

public abstract ExtDirectDocParameters parameters

(Optional) Parameters documentation that are to be placed on the api method.

Defaults to no parameters.

Default:

@ch.ralscha.extdirectspring.annotation.ExtDirectDocParameters

returnMethod

public abstract ExtDirectDocReturn returnMethod

(Optional) objects to be returned when this method is called

Defaults to no return.

Default:

@ch.ralscha.extdirectspring.annotation.ExtDirectDocReturn

deprecated

public abstract boolean deprecated

(Optional) Whether this method is deprecated

add a @deprecated to the method currently documented

Defaults to false.

Default:

false