org.apache.ambari.annotations

Annotation Type Markdown

@Retention(value=RUNTIME)
 @Target(value={TYPE,FIELD,METHOD})
public @interface Markdown

The Markdown annotation is used to add information when creating Markdown content.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description A description to add for this element when generating Markdown.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	examples An optional list of example values.
boolean	internal If true, indicates that the annotated content is for internal-use only.
String	relatedTo A way of expressing a relationship.

Element Detail

description

public abstract String description

A description to add for this element when generating Markdown.

Returns:

examples

public abstract String[] examples

An optional list of example values.

Returns:

Default:

{}

relatedTo

public abstract String relatedTo

A way of expressing a relationship.

Default:

""

internal

public abstract boolean internal

If true, indicates that the annotated content is for internal-use only.

Returns:

true for internal-only content.

Default:

false