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

Interface ScriptHintDocs

All Superinterfaces:
Serializable
public interface ScriptHintDocs extends Serializable
ScriptHintDocs provides the information that will be used when displaying the documentation that is seen when the auto-complete pop-up is active.

  • Method Details

    • getMethodSignature

      String getMethodSignature()
      Returns:
      The method signature.

    • getParameterDescriptions

      Map<String,String> getParameterDescriptions()
      Returns:
      Map of parameter names matched to their descriptions.

    • getReturnValueDescription

      String getReturnValueDescription()
      Returns:
      A synopsis of a methods return value, if any.

    • getMethodDescription

      String getMethodDescription()
      Returns:
      A method synopsis.

    • methodDescriptionIsLink

      boolean methodDescriptionIsLink()
      Returns:
      True if the method description is a link to some URL containing documentation instead of a documentation string.