io.vertx.docgen

Annotation Type Source

@Target(value={TYPE,PACKAGE,METHOD})
 @Retention(value=CLASS)
public @interface Source

Define a scope for source code inclusion: any link ref in this scope should include the content instead of linking to it.

Author:

Julien Viet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	translate Enables or disables the translation of the annotated example.

Element Detail

translate

public abstract boolean translate

Enables or disables the translation of the annotated example. When set to `false`, it also enable the inclusion of Java file (entire file) in the documentation

Default:

true