org.hkijena.jipipe.api.data

Annotation Type JIPipeDataStorageDocumentation

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface JIPipeDataStorageDocumentation

Added to JIPipeData classes to explain how the data type stores its data.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	humanReadableDescription The storage documentation.
String	jsonSchemaURL URL pointing to a JSON schema that describes how the data directory should be structured

Element Detail

humanReadableDescription

public abstract String humanReadableDescription

The storage documentation. Can contain HTML.

Returns:

the storage documentation.

jsonSchemaURL

public abstract String jsonSchemaURL

URL pointing to a JSON schema that describes how the data directory should be structured

Returns:

URL to a JSON schema document