Package ch.njol.skript.doc

Class JSONGenerator

java.lang.Object

ch.njol.skript.doc.DocumentationGenerator

ch.njol.skript.doc.JSONGenerator

public class JSONGenerator
extends DocumentationGenerator

Generates JSON docs

Field Summary

Fields

Modifier and Type	Field	Description
static final Version	JSON_VERSION	The current version of the JSON generator

Fields inherited from class ch.njol.skript.doc.DocumentationGenerator

outputDir, templateDir

Constructor Summary

Constructors

Constructor	Description
JSONGenerator(File templateDir, File outputDir)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(SkriptAddon) instead.

Method Summary

Modifier and Type	Method	Description
void	generate()	Deprecated, for removal: This API element is subject to removal in a future version. Use generate(Path) instead.
void	generate(@NotNull Path path)	Generates the json documentation for this addon at the specified path.
static JSONGenerator	of(@NotNull SkriptAddon source)	Creates a JSONGenerator for the specified source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JSON_VERSION

public static final Version JSON_VERSION

The current version of the JSON generator

Constructor Details

JSONGenerator

@Deprecated(forRemoval=true,
            since="2.13")
public JSONGenerator(File templateDir,
 File outputDir)

Deprecated, for removal: This API element is subject to removal in a future version.

Use of(SkriptAddon) instead.

Method Details

of

@Contract("_ -> new")
public static JSONGenerator of(@NotNull
 @NotNull SkriptAddon source)

Creates a JSONGenerator for the specified source.

Parameters:

source - The addon to use as source.

Returns:

The created JSONGenerator.

generate

public void generate(@NotNull
 @NotNull Path path)
              throws IOException

Generates the json documentation for this addon at the specified path.

Parameters:

path - The output path.

Throws:

IOException

generate

@Deprecated(forRemoval=true,
            since="2.13")
public void generate()

Deprecated, for removal: This API element is subject to removal in a future version.

Use generate(Path) instead.

Description copied from class: DocumentationGenerator

Use generate(Path) instead.

Specified by:

generate in class DocumentationGenerator