Package ch.njol.skript.doc

package ch.njol.skript.doc

Code related to generation a documentation to be published on a website for example.

Related Packages

Package	Description
ch.njol.skript	The package for the bukkit plugin Skript.

Class	Description
Description	Provides a description for annotated element in documentation.
Documentable	Represents any object that can be documented using methods.
Documentation	TODO list special expressions for events and event values TODO compare doc in code with changed one of the webserver and warn about differences?
DocumentationGenerator	Deprecated, for removal: This API element is subject to removal in a future version. Use JSONGenerator instead.
DocumentationId	Sets documentation id for the annotated element.
DocumentationIdProvider
Events
Example	An example to be used in documentation for the annotated element.
Example.Examples	The internal container annotation for multiple examples.
Examples	Provides a list of examples to be used in documentation for annotated element.
HTMLGenerator	Template engine, primarily used for generating Skript documentation pages by combining data from annotations and templates.
JSONGenerator	Generates JSON docs
Keywords	Provides a list of keywords that will allow for easier documentation searching.
Name	Provides the name of annotated element to be used in documentation.
NoDoc	Annotated element will not appear in documentation, nor will missing documentation about it cause warnings.
RelatedProperty	Provides a Property to be used in documentation.
RequiredPlugins	Provides a list of plugins other than Skript that the annotated element requires to be used.
Since	Provides the version of plugin when was the annotated element added.