Page History

@AllowToRunInFind

@AllowToRunInFind

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}  

Tag indicating the author of the code

@constructor

@constructor

@deprecated

@deprecated  

Tag indicating that the function or variable is obsolete or has been replaced and should be used anymore

@example

@example  

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

@param

@param {Type} name parameterDescription

  Tag to describe function parameters

@private

@private

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

@protected

@protected

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

@return

@return {Type}

@returns

@returns {Type}

alias for @return

@see

@see seeDescription

@since

@since versionDescription

@SuppressWarnings

@SuppressWarnings (warning)

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

@throws

@throws {Type}

@type

@type {Type}

@version

@version versionDescription