Package ch.njol.skript.doc
Class DocumentationIdProvider
java.lang.Object
ch.njol.skript.doc.DocumentationIdProvider
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
Gets the documentation ID of a ClassInfostatic String
Gets the documentation ID of a functionstatic String
getId
(SkriptEventInfo<?> eventInfo) Gets the documentation ID of an eventstatic <T> String
getId
(SyntaxElementInfo<? extends T> syntaxInfo) Gets the documentation ID of a syntax element
-
Constructor Details
-
DocumentationIdProvider
public DocumentationIdProvider()
-
-
Method Details
-
getId
Gets the documentation ID of a syntax element- Parameters:
syntaxInfo
- the SyntaxElementInfo to get the ID of- Returns:
- the ID of the syntax element
-
getId
Gets the documentation ID of a function- Parameters:
function
- the function to get the ID of- Returns:
- the documentation ID of the function
-
getId
Gets the documentation ID of a ClassInfo- Parameters:
classInfo
- the ClassInfo to get the ID of- Returns:
- the ID of the ClassInfo
-
getId
Gets the documentation ID of an event- Parameters:
eventInfo
- the event to get the ID of- Returns:
- the ID of the event
-