Package ch.njol.skript.doc

Class HTMLGenerator

java.lang.Object

ch.njol.skript.doc.DocumentationGenerator

ch.njol.skript.doc.HTMLGenerator

public class HTMLGenerator
extends DocumentationGenerator

Template engine, primarily used for generating Skript documentation pages by combining data from annotations and templates.

Field Summary

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

outputDir, templateDir

Constructor Summary

Constructors

Constructor	Description
HTMLGenerator(File templateDir, File outputDir)

Method Summary

Modifier and Type	Method	Description
void	generate()	Generates documentation using template and output directories given in the constructor.
String[]	getDefaultIfNullOrEmpty(@Nullable String[] string, String message)
String	getDefaultIfNullOrEmpty(@Nullable String string, String message)	Checks if a string is empty or null then it will return the message provided

Methods inherited from class java.lang.Object

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

Constructor Details

HTMLGenerator

public HTMLGenerator(File templateDir,
 File outputDir)

Method Details

generate

public void generate()

Generates documentation using template and output directories given in the constructor.

Specified by:

generate in class DocumentationGenerator

getDefaultIfNullOrEmpty

public String getDefaultIfNullOrEmpty(@Nullable
 @Nullable String string,
 String message)

Checks if a string is empty or null then it will return the message provided

Parameters:

string - the String to check

message - the String to return if either condition is true

getDefaultIfNullOrEmpty

public String[] getDefaultIfNullOrEmpty(@Nullable
 @Nullable String[] string,
 String message)