org.hkijena.jipipe.api

Annotation Type JIPipeDocumentation

@Retention(value=RUNTIME)
public @interface JIPipeDocumentation

Used within JIPipe to annotate types and methods with documentation

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description
Class<?>	descriptionResourceClass The class where descriptionResourceURL loads the description from.
String	descriptionResourceURL A resource URL that points to a markdown/html file within a JAR resource.
String	name

Element Detail

name

public abstract String name

Returns:

The name

Default:

""

description

public abstract String description

Returns:

The description

Default:

""

descriptionResourceURL

public abstract String descriptionResourceURL

A resource URL that points to a markdown/html file within a JAR resource. Use descriptionResourceClass to change this class if needed. If not empty, this overrides the description setting.

Returns:

the description resource URL

Default:

""

descriptionResourceClass

public abstract Class<?> descriptionResourceClass

The class where descriptionResourceURL loads the description from.

Returns:

resource class

Default:

org.hkijena.jipipe.JIPipe.class