ScriptFunctionDocProvider

All Known Implementing Classes:

PropertiesFileDocProvider
```
public interface ScriptFunctionDocProvider
```

Field Summary

Fields
Modifier and Type Field Description

static ScriptFunctionDocProvider NO_DOC_PROVIDER

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	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)`

- Field Detail
  - NO_DOC_PROVIDER
```
static final ScriptFunctionDocProvider NO_DOC_PROVIDER
```
- Method Detail
  - getMethodDescription
```
java.lang.String getMethodDescription(java.lang.String path,
                                      java.lang.reflect.Method m)
```
    Parameters:
    
    path - The path this function is being added at, as given to the ScriptManager.
    
    m - The Method being added as a scripting function.
    
    Returns:
    
    A description of what the function does.
  - getParameterDescriptions
```
java.util.Map<java.lang.String,java.lang.String> getParameterDescriptions(java.lang.String path,
                                                                                java.lang.reflect.Method m)
```
    Parameters:
    
    path - The path this function is being added at, as given to the ScriptManager.
    
    m - The Method being added as a scripting function.
    
    Returns:
    
    Map of parameter names matched to their descriptions.
  - getReturnValueDescription
```
java.lang.String getReturnValueDescription(java.lang.String path,
                                           java.lang.reflect.Method m)
```
    Parameters:
    
    path - The path this function is being added at, as given to the ScriptManager.
    
    m - The Method being added as a scripting function.
    
    Returns:
    
    A description of the function's return value.