Class description doc comments first line.
Additional class description documentation comments.
Code sample:
var c:ExampleClass = new ExampleClass();
| ExampleClass(constructorParam:String='A constructor parameter') | Constructor doc comments first line. |
| constant():String | static Constant field doc comments first and only line. |
| public_field():String | Public field doc comments first line. |
| public_templated_field():Vector.<String> | Public templated field doc comments first line. |
| protected_field():String | Protected field doc comments first line.Additional doc comments from another class |
| read_only_templated_property():Dictionary.<String, Number> | read only Public read-only templated property doc comments first line. |
| read_only_property():ExampleEnum | read only Public read-only property doc comments first line.Additional doc comments from overriding subclass |
| property():String | Public property getter doc comments first line.Additional doc comments from overriding subclass |
| interface_method(param1:String, ...rest:Vector.<Object>):void | Public interface method doc comments first line. |
| method(param1:String, param2:String='child default'):String | Public method doc comments first line. |
| method_template_return():Vector.<String> | Templated return value method signature doc comments first line. |
| kitchen_sink_method(param1:Vector.<Object>, param2:Dictionary.<String, Vector.<Object>>, param3:Vector.<Vector.<Vector.<Number>>>, ...args:Vector.<Object>):void | Kitchen sink method signature doc comments first line. |
| protected_method(param1:String, param2:Number=null):void | Protected method doc comments first line. |
public function ExampleClass(constructorParam:String='A constructor parameter')
Constructor doc comments first line.
This constructor takes an optional parameter. Not all constructors do. Some take none at all.
constructorParam:String='A constructor parameter' | optional Initialization info
|
public static const constant():String
Constant field doc comments first and only line.
public public_field():String
Public field doc comments first line.
Second paragraph.
Third paragraph.
public public_templated_field():Vector.<String>
Public templated field doc comments first line.
protected protected_field():String
Protected field doc comments first line.Additional doc comments from another class
public read_only_templated_property():Dictionary.<String, Number>
Public read-only templated property doc comments first line.
returns Dictionary.<String, Number> | A |
public read_only_property():ExampleEnum
Public read-only property doc comments first line.Additional doc comments from overriding subclass
returns ExampleEnum | An enumeration value |
public property():String
Public property getter doc comments first line.Additional doc comments from overriding subclass
returns String | The literal string phrase ‘value’. |
public function interface_method(param1:String, ...rest:Vector.<Object>):void
Public interface method doc comments first line.
This method has one required first parameter,
and can accept any number of additional params via the rest arg (...).Additional doc comments from overriding subclass
param1:String | The first parameter (required) |
...rest:Vector.<Object> | optional Any additional params (optional)
|
public function method(param1:String, param2:String='child default'):String
Public method doc comments first line.
This method has one required first parameter, and an optional second parameter.Additional doc comments from overriding subclass
param1:String | The first parameter (required) |
param2:String='child default' | optional The second parameter (optional)
|
returns String | The value of param2 is always returned. |
public function method_template_return():Vector.<String>
Templated return value method signature doc comments first line.
This method signature has a templated return type.
returns Vector.<String> | A |
public function kitchen_sink_method(param1:Vector.<Object>, param2:Dictionary.<String, Vector.<Object>>, param3:Vector.<Vector.<Vector.<Number>>>, ...args:Vector.<Object>):void
Kitchen sink method signature doc comments first line.
This method signature has 3 template type params and varargs.
param1:Vector.<Object> | A Vector of anything
|
param2:Dictionary.<String, Vector.<Object>> | A Dictionary using String values to look up Vectors of anything
|
param3:Vector.<Vector.<Vector.<Number>>> | A 3D matrix: m[x][y][z] = 0
|
...args:Vector.<Object> | optional An optional varargs catchall for any additional params the user wants to supply
|
protected function protected_method(param1:String, param2:Number=null):void
Protected method doc comments first line.
This method has one required first parameter without any documentation, and one optional second parameter with documentation.Additional doc comments from overriding subclass
param1:String | |
param2:Number=null | optional The second parameter (optional)
|
|
lsdoc
2018 pixeldroid
https://github.com/pixeldroid/lsdoc |
| programming pages theme v0.5.10 (https://github.com/pixeldroid/programming-pages) |
s |
focus search bar ( enter to select, ▲ / ▼ to change selection) |
g a |
go to api |
g e |
go to examples |
g g |
go to guides |
h |
toggle this help ( esc also exits) |