Package com.inductiveautomation.ignition.common.script.hints

Interface ScriptFunctionDocProvider

All Known Implementing Classes:
PropertiesFileDocProvider
public interface ScriptFunctionDocProvider

  • Field Details

  • Method Details

    • getMethodDescription

      String getMethodDescription(String path, 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

      Map<String,String> getParameterDescriptions(String path, 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

      String getReturnValueDescription(String path, 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.