Module ch.ralscha.extdirectspring

Package ch.ralscha.extdirectspring.annotation

Annotation Interface ExtDirectMethodDocumentation

@Target({METHOD,ANNOTATION_TYPE})
@Retention(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	Description
String	author	(Optional) method author
boolean	deprecated	(Optional) Whether this method is deprecated
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
String	value	(Optional) the method comment if method description is empty, the documentation for this method will be skipped
String	version	(Optional) method version

Element Details

value

String value

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

Default:

""

author

String author

(Optional) method author

add a @author to the method currently documented

Defaults to empty.

Default:

""

version

String version

(Optional) method version

add a @version to the method currently documented

Defaults to 1.0.

Default:

"1.0"

parameters

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

ExtDirectDocReturn returnMethod

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

Defaults to no return.

Default:

@ch.ralscha.extdirectspring.annotation.ExtDirectDocReturn

deprecated

boolean deprecated

(Optional) Whether this method is deprecated

add a @deprecated to the method currently documented

Defaults to false.

Default:

false