Class ScriptBindingDocumentation
java.lang.Object
org.ametys.plugins.core.ui.script.ScriptBindingDocumentation
A class that hold the documentation of one function or one variable
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Describes an argument when a function is documentedstatic class
Examplestatic class
A signature. -
Constructor Summary
ConstructorDescriptionScriptBindingDocumentation
(I18nizableText name, I18nizableText text, ScriptBindingDocumentation.Signature signature, List<ScriptBindingDocumentation.Example> examples) Creates a documentation object -
Method Summary
-
Constructor Details
-
ScriptBindingDocumentation
public ScriptBindingDocumentation(I18nizableText name, I18nizableText text, ScriptBindingDocumentation.Signature signature, List<ScriptBindingDocumentation.Example> examples) Creates a documentation object- Parameters:
name
- The name of the documented stufftext
- The descriptionsignature
- The signatureexamples
- The examples
-
-
Method Details
-
asMap
The documentation as a map- Returns:
- The documentation as a map
-
getName
The documentation name- Returns:
- The documentation name
-
getText
The description- Returns:
- The description
-
getSignature
The signature- Returns:
- The signature
-
getExamples
The examples- Returns:
- The examples
-