dev.jeka.core.tool

Annotation Type JkDoc

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

Documents the annotated element so that Jeka can display some information when 'help' is invoked from command line.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	hide If true, the method/field won't be displayed in 'help' command.
java.lang.String	value The text to display when help is requested.

Element Detail

value

public abstract java.lang.String value

The text to display when help is requested. The first line is for short description (or heading).

Default:

""

hide

public abstract boolean hide

If true, the method/field won't be displayed in 'help' command.

Default:

false