com.inductiveautomation.ignition.common.script.hints

Annotation Type ScriptFunction

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface ScriptFunction

Annotates a function added to the scripting system.

Provides a location to look up a documentation string that will be used in the script hints auto-complete system.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	docBundlePrefix Documentation is expected to be in the following format:

Element Detail

docBundlePrefix

public abstract java.lang.String docBundlePrefix

Documentation is expected to be in the following format:

 methodName.desc=Description of method goes here.
 methodName.param.paramName=Description of parameter.
 methodName.returns=Return type/description.
 

If a method returns void then that line can be left out of the properties file.

A properties file with this key must reside in each scope that the function is available in.

Returns:

The prefix of the bundle that documentation for this function can be looked up with.

Default:

""