ExampleSuperClass

public CLASS
 

Class Description

SuperClass description doc comments first line.

Additional class description documentation comments.

See Also

 

Listing

 

Constructor

ExampleSuperClass()Constructor doc comments first line.
 

Fields

parent_constant():String
static
Constant field doc comments first line.
parent_public_field():StringPublic field doc comments first line.
parent_protected_field():StringProtected field doc comments first line.
 

Properties

property():StringPublic property getter doc comments first line.
read_only_property():ExampleEnum
read only
Public read-only property doc comments first line.
legacy_property():String
deprecated v2.1.3
read only
Unfashionable old property.
 

Methods

interface_method(param1:String, ...rest:Vector.<Object>):voidPublic interface method doc comments first line.
method(param1:String, param2:String='parent default'):StringPublic method doc comments first line.
protected_method(param1:String, param2:Number=null):voidProtected method doc comments first line.
 

Details

 

Constructor

 

ExampleSuperClass()

public function ExampleSuperClass()

Constructor doc comments first line.

 

Fields

 

parent_constant
static

public static const parent_constant():String

Constant field doc comments first line.

 

parent_public_field

public parent_public_field():String

Public field doc comments first line.

 

parent_protected_field

protected parent_protected_field():String

Protected field doc comments first line.

 

Properties

 

property

public property():String

Public property getter doc comments first line.

returns
String

The literal string phrase ‘value’.

 

read_only_property
read only

public read_only_property():ExampleEnum

Public read-only property doc comments first line.

returns
ExampleEnum

An enumeration value

 

legacy_property
deprecated v2.1.3
read only

public legacy_property():String

Unfashionable old property.

returns
String

A string value

 

Methods

 

interface_method()

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 (...).

param1:StringThe first parameter (required)
...rest:Vector.<Object>
optional
 Any additional params (optional)
 

method()

public function method(param1:String, param2:String='parent default'):String

Public method doc comments first line.

This method has one required first parameter, and an optional second parameter.

param1:StringThe first parameter (required)
param2:String='parent default'
optional
 The second parameter (optional)
returns
String

The value of param2 is always returned.

 

protected_method()

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.

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)