Child pages
  • JSDoc Annotations

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expression name

Syntax example

Context

Comments

Named type

{String}
{Boolean}
{Number}
{XML}
{XMLList}
{RuntimeForm}
{RuntimeLabel}
{JSButton}
{JSForm}

@param, @return, @type, @throws

 

AnyType

*
Any type of value

@param, @return, @type, @throws

 

OR Type

{String|Number}
Either a String or a Number

@param, @return, @type, @throws

 

REST Type

{...String}
Indicates one or more String values

@param

 <ac:structured-macro ac:name="

Array Type

Wiki Markup
" ac:schema-version="1" ac:macro-id="f93d56d4-d9a6-4d53-9c70-29afab4092bf"><ac:plain-text-body><![CDATA[

Array Type

{String[]} 
]]></ac:plain-text-body></ac:structured-macro>

\{String\[\]}

{Array<String>} 
An array containing just string values 

{Array<Byte>}
An array containing just bytes

@param, @return, @type, @throws

 

Object Type

{Object<String>} 
An object where the value for each key is a String value

{Object<Array<String>>} 
An object where the value for each key contains arrays that in turn contains only string values

 {name:String, age:Number}} 
An object with a "name" and "age" key, with resp. a string and number value

@param, @return, @type, @throws

 <ac:structured-macro ac:name="

Object Type with optional properties

Wiki Markup
" ac:schema-version="1" ac:macro-id="19b7bf11-b4bf-417e-84ce-bf9fa8bf69f7"><ac:plain-text-body><![CDATA[

Object Type with optional properties

{ {sDocID:String, [sTemplateID]:String}}
]]></ac:plain-text-body></ac:structured-macro>
{ {sDocID:String, sTemplateID:String=}}

\{ \{name:String, \[age\]:Number}}

 { {name:String, age:Number=}}
An object with a "name" and optional "age" key, with resp. a string and number value

@param, @return, @type, @throws

 

JSFoundSet type

{JSFoundset<db:/udm/contacts>}1  
A JSFoundSet from the contacts table of the udm database server
{JSFoundset<{column1col1:String, column2col2:Number}>}
A JSFoundSet with dataproviders "col1" and "col2" with resp. string and number types

@param, @return, @type

 

JSRecord type

{JSRecord<db:/udm/contacts>}{^}1^
A JSRecord from the contacts table of the udm database server
{JSRecord<{column1col1:String, column2col2:Number}>}
A JSFoundSet with dataproviders "col1" and "col2" with resp. string and number types

@param, @return, @type

 

JSDataSet type

{JSDataSet<{name:String, age:Number}>}
An JSDataSet with a "name" and "age" column, with resp. a string and number value

@param, @return, @type

 

RuntimeForm Type

{RuntimeForm<superFormName>}
A RuntimeForm that extends superFormName

@param, @return, @type

 

^1^ the value in between <..> is the datasource notation that is built up of the database server and tablename: db:/{serverName}/{tableName}

...