de.lmu.ifi.dbs.elki.utilities.documentation

Annotation Type Reference

@Documented
 @Repeatable(value=References.class)
 @Retention(value=RUNTIME)
 @Target(value={TYPE,FIELD,METHOD,PACKAGE})
public @interface Reference

Annotation to specify a reference.

Since:

0.3

Author:

Erich Schubert

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	authors Publication Authors
java.lang.String	booktitle Book title or Journal title etc.
java.lang.String	title Publication title.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	bibkey BibTeX key
java.lang.String	prefix Prefix to the reference, e.g.
java.lang.String	url Reference URL, e.g.

Element Detail

title

public abstract java.lang.String title

Publication title.

Returns:

publication title

authors

public abstract java.lang.String authors

Publication Authors

Returns:

authors

booktitle

public abstract java.lang.String booktitle

Book title or Journal title etc.

Returns:

book title

prefix

public abstract java.lang.String prefix

Prefix to the reference, e.g. "Generalization of a method proposed in"

Returns:

Prefix or empty string

Default:

""

url

public abstract java.lang.String url

Reference URL, e.g. DOI

Returns:

Reference URL or empty string

Default:

""

bibkey

public abstract java.lang.String bibkey

BibTeX key

Returns:

BibTeX in the bibliography

Default:

""