org.hkijena.jipipe.api

Annotation Type JIPipeDocumentationDescription

@Retention(value=RUNTIME)
 @Repeatable(value=JIPipeDocumentationDescriptions.class)
 @Inherited
public @interface JIPipeDocumentationDescription

Allows to separate the description part of a JIPipeDocumentation into multiple items.

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.

Element Detail

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