Interface ScriptHintDocs

  • All Superinterfaces:
    java.io.Serializable

    public interface ScriptHintDocs
    extends java.io.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 Detail

      • getMethodSignature

        java.lang.String getMethodSignature()
        Returns:
        The method signature.
      • getParameterDescriptions

        java.util.Map<java.lang.String,​java.lang.String> getParameterDescriptions()
        Returns:
        Map of parameter names matched to their descriptions.
      • getReturnValueDescription

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

        java.lang.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.