Page History
...
Tag | Syntax & Examples | Context | Impact | Description | ||
---|---|---|---|---|---|---|
@AllowToRunInFind | @AllowToRunInFind | function | Determines if the function will be executes in FindMode when used as an event handler | 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 | none | Indicates the author of the code | ||
@constructor | @constructor | function | This will show a different icon on the Script Outline view. besides that no further impact |
| ||
@deprecated | @deprecated | function, variable | Accessing a deprecated variable or calling a deprecated function will produce a builder marker in Servoy Developer | Indicates that the function or variable is obsolete or has been replaced and should be used anymore. | ||
@example | @example | function | none | Tag allowing to provide some sample code how to use the function or variable. Multiline content is possible my including "<br>" as line-breaks behind each line of content | ||
@param | @param {Type} name parameterDescription | function | Builder markers will be generated in Servoy Developer if the function is called with values for the parameters that do no | Describe function parameters. | ||
@private | @private | function, variable | Accessing a private variable/function from outside the scope in which it is declared will generate a builder marker in Servoy Developer | Annotates a variable or function as accessible only from within the file in which it is declared | ||
@protected | @protected | function, variable | Accessing a protected variable/function from outside the scope in which it is declared or a child scope will generate a builder marker in Servoy Developer | Annotates a variable or function as accessible from within the same file in which it is declared and all files that extend this file | ||
@return | @return {Type} | function | The specified type is used by the build process to determine the correctness of the code that uses the returned value | Annotates the type of the returned value. | ||
@returns | @returns {Type} | function | see @return | alias for @return | ||
@see | @see seeDescription | function, variable | none | Tag to provide pointers to other parts of the code that are related | ||
@since | @since versionDescription | function, variable | none | Tag to provide information about in which version of the code the variable or function was introduced | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f6b7435b6afe0a90-8c32548d-46a34c52-8208b109-cdd2ec959b1571bccb8814fb"><ac:plain-text-body><![CDATA[ | @SuppressWarnings | @SuppressWarnings ([deprecated], [hides], [wrongparameters], [undeclared]) | function | Stop the generation of builder markers in Servoy Developer for the specified warnings | Custom Servoy JSDoc tag to suppress builder markers of a certain type within a function. | ]]></ac:plain-text-body></ac:structured-macro> |
@throws | @throws {Type} | function | none | Tag to describe the type of Exceptions that can be raised when the function is called. | ||
@type | @type {Type} | variable, inline variable, (function*) | The specified type is used by the build process to determine the correctness of the code that uses the variable | Tag to specify the type of the value that a variable can hold. | ||
@version | @version versionDescription | function, variable | none | Tag to provide information about the version of the code |
...
1 the value in between <..> is the datasource notation that is built up of the database server and tablename: db:/{serverName}/{tableName}
Casting
Wiki Markup |
---|
When you have an array/object which holds some elements that you get by index (array\[1\]) or by name (array\['name'\] or object.name) and the array doesn't specify the type of the objects it holds like Array<String> or it does hold a super type so not the actual type an example is Servoy own form elements object/array. |
The elements of the form is typed as an Object<RuntimeComponent> because all elements do have that type in common. RuntimeComponent has for example the background color and so on. But if you want to have a specific property called of a certain element in the element scope/object like: elements.mylabel.text, then this text property is not someting that the RuntimeComponent type has, but that is a property of the RuntimeLabel type. So to access that text property without any warning you have to cast it.
Casting only works when making a new variable where you specify through JSDoc the type and assign the element from the Array or Object to that variable. So instead of doing this:
Code Block |
---|
elements.mylabel.text = "hallo"
|
You have to do this:
Code Block |
---|
/** @type {RuntimeLabel} */ var mylabel = elements.mylabel; mylabel.text = "hallo" |