Page History

@AllowToRunInFind

@AllowToRunInFind

function

Custom Servoy JSDoc tag to annotate a function that it can be run if the Form on which the function is ran is in FindMode

@author

@author {userName}

function, variable

Tag indicating the author of the code

@constructor

@constructor

function

...

@deprecated

@deprecated

function, variable

Tag indicating Indicates that the function or variable is obsolete or has been replaced and should be used anymore. Accessing a deprecated variable or calling a deprecated function will produce a builder marker in Servoy Developer

@example

@example

function

Tag allowing to provide some sample code how to use the function or variable

@param

@param {Type} name parameterDescription

function
Tag

to describe Describe function parameters.

@private

@private

function, variable

Annotates a variable or function as accessible only from within the scope¹ in which it is declared

@protected

@protected

function, variable

Annotates a variable or function as accessible from within the scope¹ in which it is declared and all scopes that extend this scope

@return

@return {Type}

function

Annotates the type of the returned value

@returns

@returns {Type}

function

alias for @return

@see

@see seeDescription

function, variable

Tag to provide pointers to other parts of the code that are related

@since

@since versionDescription

function, variable

Tag to provide information about in which version of the code the variable or function was introduced

@SuppressWarnings

@SuppressWarnings (warningwarnings)

function

Custom Servoy JSDoc tag to suppress builder markers of a certain type within a function

@throws

@throws {Type}

function

Tag to describe the type of Exceptions that can be raised when the function is called. Multiple @throws tags are allowed

@type

@type {Type}

variable, inline variable

Tag to specify the type of the value that a variable can hold

@version

@version versionDescription

function, variable

Tag to provide information about the version of the code