Titanium Mobile # ScriptDoc tag quick reference
This page provides an at-a-glance reference for the tags for the Studio ScriptDoc system. For comprehensive ScriptDoc tag information, including syntax and examples, see the ScriptDoc (SDOC) 2.0 Specification page.
# Reference
Tag | Recognized | Affects Content Assist | Description |
|
| ID for a class or function. | |
|
| Author of a JavaScript file or function. | |
|
| Description of the class (if applicable). | |
|
| It signifies that a function is a constructor for a class. | |
|
| It signifies that a function or a property has been deprecated. | |
|
| Gives an example of the function being documented. | |
|
| Specifies the type of exception thrown by a function. | |
|
| Unique identifier for a function or property. | |
|
| Indicated one "class" derives from another. | |
|
| Specifies that a function or property should not be made visible by Content Assist. | |
|
| It signifies that a function is a member of the specified class. | |
|
| It signifies that a function is a method of a class, if applicable. | |
|
| Creates the link between the namespace of a library file and an external .sdoc file. | |
|
| Specifies that a function or property is a native function or property.</td> | |
|
| Use @param to tag each parameter for a function. | |
|
| It signifies that a class or function is private. | |
|
| Gives a description of the JavaScript file. | |
|
| Any additional remarks that you want to add about a function or class. | |
|
| Specifies information about the return value(s) of a function. | |
|
| Defines the path to an external .sdoc file for a library file. | |
|
| Links to another related class or function. | |
|
| Specifies since which version the library, function, or property became valid. | |
|
| Specifies what data type a property is. | |
|
| Specifies the version number of the JavaScript file or class. |
