org.jsondoc.core.annotation.global

Annotation Type ApiGlobalSection

@Documented
 @Target(value=ANNOTATION_TYPE)
 @Retention(value=RUNTIME)
public @interface ApiGlobalSection

This annotation has to be used in a ApiGlobal annotation. It represents a block of information of the same context like http verbs, authentication, common headers, etc

Author:

Fabio Maffioletti

See Also:

ApiGlobal

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	title The title of this section

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	paragraphs An array that can be made of two things: a text (may contain html tags) or a path to a file in the classpath, containing a text.

Element Detail

title

public abstract String title

The title of this section

Returns:

paragraphs

public abstract String[] paragraphs

An array that can be made of two things: a text (may contain html tags) or a path to a file in the classpath, containing a text. In this case the array item should have the /jsondocfile prefix, for example: /jsondocfile./src/main/resources/jsondoc/global-verbs.html

Returns:

Default:

{}