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: 3798 $ Last update : $Date: 2012-10-30 11:39:32 +0100 (Tue, 30 Oct 2012) $ By : $Author: echatellier $

Author:

chemit

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Get content of the documentation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	author Get documentation author (optional).
String	date Get documentation date (optional).
String	version Get documentation version (optional).

Element Detail

value

public abstract String value

Get content of the documentation.

Returns:

the content of the documentation

date

public abstract String date

Get documentation date (optional).

Returns:

optional date

Default:

""

version

public abstract String version

Get documentation version (optional).

Returns:

optional version

Default:

""

author

public abstract String author

Get documentation author (optional).

Returns:

optional author of the documentation

Default:

""