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

Annotation Interface JythonElement

@Retention(RUNTIME) @Target({METHOD,FIELD}) public @interface JythonElement
Annotates a function added to the scripting system.

This annotation is used by PropertiesFileDocProvider to provide meta-information about the function, such as which bundle prefix to use when looking up documentation in properties files.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    docBundlePrefix
     

  • Element Details

    • docBundlePrefix

      String docBundlePrefix
      Returns:
      The prefix of the bundle that documentation for this function can be looked up with. If omitted, no prefix will be used when looking up the bundle. This prefix is prepended to keys in the properties file (e.g., Prefix.functionName.desc).
      Default:
      ""