Page History
...
Use case | Tag | Example |
---|---|---|
function parameters | @param | /** |
function return type | @return | /** |
functions exceptions | @throws | /** |
variables | @type | /** |
|
|
|
A Type Expression is to always be surrounded by curly braces: {typeExpression}. Note that when using the Object Type expression variation that start and stops with curly braces as well, this results in double opening and closing braces.
Expression name | Syntax example | Context | Comments | |
---|---|---|---|---|
Named type | {String} | @param, @return, @type, @throws |
| |
AnyType | * | @param, @return, @type, @throws |
| |
OR Type | {String|Number} | @param, @return, @type, @throws |
| |
REST Type | {...String} | @param |
| |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3e7827d865f6601c-4a6cb97b-484448fa-8e488277-4093aed51f9b92f49808361b"><ac:plain-text-body><![CDATA[ | Array Type | {String[]} | @param, @return, @type, @throws |
|
Object Type | {Object<String>} | @param, @return, @type, @throws |
| |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e150d61439b72cfc-9fdb35e7-4ba44416-9c83a865-cd202f19c312f124b67f91fc"><ac:plain-text-body><![CDATA[ | Object Type with optional properties | { {sDocID:String, [sTemplateID]:String}} | @param, @return, @type, @throws |
|
JSFoundSet type | {JSFoundset<db:/udm/contacts>}1 | @param, @return, @type |
| |
JSRecord type | {JSRecord<db:/udm/contacts>}{^}1^ | @param, @return, @type |
| |
JSDataSet type | {JSDataSet<{name:String, age:Number}>} | @param, @return, @type |
| |
RuntimeForm Type | {RuntimeForm<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}
...