public interface ScriptFunctionDocProvider
Modifier and Type | Field and Description |
---|---|
static ScriptFunctionDocProvider |
NO_DOC_PROVIDER |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getMethodDescription(java.lang.String path,
java.lang.reflect.Method m) |
java.util.Map<java.lang.String,java.lang.String> |
getParameterDescriptions(java.lang.String path,
java.lang.reflect.Method m) |
java.lang.String |
getReturnValueDescription(java.lang.String path,
java.lang.reflect.Method m) |
static final ScriptFunctionDocProvider NO_DOC_PROVIDER
java.lang.String getMethodDescription(java.lang.String path, java.lang.reflect.Method m)
path
- The path this function is being added at, as given to the ScriptManager
.m
- The Method
being added as a scripting function.java.util.Map<java.lang.String,java.lang.String> getParameterDescriptions(java.lang.String path, java.lang.reflect.Method m)
path
- The path this function is being added at, as given to the ScriptManager
.m
- The Method
being added as a scripting function.java.lang.String getReturnValueDescription(java.lang.String path, java.lang.reflect.Method m)
path
- The path this function is being added at, as given to the ScriptManager
.m
- The Method
being added as a scripting function.