Package ch.njol.skript.doc

Class Documentation

java.lang.Object

ch.njol.skript.doc.Documentation

public class Documentation
extends Object

TODO list special expressions for events and event values TODO compare doc in code with changed one of the webserver and warn about differences?

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	FORCE_HOOKS_SYSTEM_PROPERTY	Force register hooks even if their plugins are not present in the server
static final boolean	generate

Constructor Summary

Constructors

Constructor	Description
Documentation()

Method Summary

Modifier and Type	Method	Description
static boolean	canGenerateUnsafeDocs()	Checks if server java args have 'skript.forceregisterhooks' property set to true and docs template folder is found
protected static String	cleanPatterns(String patterns)
protected static String	cleanPatterns(String patterns, boolean escapeHTML)
protected static String	cleanPatterns(String patterns, boolean escapeHTML, boolean useLinks)
static String	escapeHTML(@Nullable String value)
static String[]	escapeHTML(@Nullable String[] values)
static void	generate()
static File	getDocsOutputDirectory()
static File	getDocsTemplateDirectory()
static boolean	isDocsTemplateFound()

Methods inherited from class java.lang.Object

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

Field Details

FORCE_HOOKS_SYSTEM_PROPERTY

public static final boolean FORCE_HOOKS_SYSTEM_PROPERTY

Force register hooks even if their plugins are not present in the server

generate

public static final boolean generate

Constructor Details

Documentation

public Documentation()

Method Details

isDocsTemplateFound

public static boolean isDocsTemplateFound()

canGenerateUnsafeDocs

public static boolean canGenerateUnsafeDocs()

Checks if server java args have 'skript.forceregisterhooks' property set to true and docs template folder is found

getDocsTemplateDirectory

public static File getDocsTemplateDirectory()

getDocsOutputDirectory

public static File getDocsOutputDirectory()

generate

public static void generate()

cleanPatterns

protected static String cleanPatterns(String patterns)

cleanPatterns

protected static String cleanPatterns(String patterns,
 boolean escapeHTML)

cleanPatterns

protected static String cleanPatterns(String patterns,
 boolean escapeHTML,
 boolean useLinks)

escapeHTML

public static String escapeHTML(@Nullable
 @Nullable String value)

escapeHTML

public static String[] escapeHTML(@Nullable
 @Nullable String[] values)