fr.ifremer.isisfish.util
Annotation Type Doc

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface Doc

Used by user to add informations about a code he wrote.

Version:

$Revision: 2507 $ Last update : $Date: 2009-07-20 15:38:55 +0200 (lun., 20 juil. 2009) $ By : $Author: chatellier $

Author:

chemit

Required Element Summary

java.lang.String

value Get content of the documentation.

Optional Element Summary

java.lang.String	author Get documentation author (optional).
java.lang.String	date Get documentation date (optional).
java.lang.String	version Get documentation version (optional).

Element Detail

value

public abstract java.lang.String value

Get content of the documentation.

Returns:

the content of the documentation

date

public abstract java.lang.String date

Get documentation date (optional).

Returns:

optional date

Default:

""

version

public abstract java.lang.String version

Get documentation version (optional).

Returns:

optional version

Default:

""

author

public abstract java.lang.String author

Get documentation author (optional).

Returns:

optional author of the documentation

Default:

""