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

java.lang.Object
  de.lmu.ifi.dbs.elki.utilities.documentation.DocumentationUtil

public final class DocumentationUtil
extends Object

Utilities for extracting documentation from class annotations.

Constructor Summary

DocumentationUtil()

Method Summary

static String	getDescription(Class<?> c) Get a class description if defined, an empty string otherwise.
static Reference	getReference(Class<?> c) Get the reference annotation of a class, or null.
static String	getTitle(Class<?> c) Get a useful title from a class, either by reading the "title" annotation, or by using the class name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentationUtil

public DocumentationUtil()

Method Detail

getTitle

public static String getTitle(Class<?> c)

Get a useful title from a class, either by reading the "title" annotation, or by using the class name.

Parameters:

c - Class

Returns:

title

getDescription

public static String getDescription(Class<?> c)

Get a class description if defined, an empty string otherwise.

Parameters:

c - Class

Returns:

description or the emtpy string

getReference

public static Reference getReference(Class<?> c)

Get the reference annotation of a class, or null.

Parameters:

c - Class

Returns:

Reference or null