ExampleStruct

public STRUCT
 

Struct Description

Struct description doc comments first line.

Additional struct description documentation comments.

 

Listing

 

Constructor

ExampleStruct(x:Number=1, y:Number=2)Constructor doc comments first line.
 

Fields

x():NumberPublic field doc comments first line.
y():NumberPublic field doc comments first line.
 

Methods

=(a:ExampleStruct, b:ExampleStruct):ExampleStruct
static
Public static operator doc comments first line.
+(a:ExampleStruct, b:ExampleStruct):ExampleStruct
static
Public static operator doc comments first line.
+=(b:ExampleStruct):voidPublic operator doc comments first line.
 

Details

 

Constructor

 

ExampleStruct()

public function ExampleStruct(x:Number=1, y:Number=2)

Constructor doc comments first line.

This constructor takes two optional parameters. Not all constructors do. Some take none at all.

x:Number=1
optional
 Value for the x component
y:Number=2
optional
 Value for the y component
 

Fields

 

x

public x():Number

Public field doc comments first line.

 

y

public y():Number

Public field doc comments first line.

 

Methods

 

=()
static

public operator static function =(a:ExampleStruct, b:ExampleStruct):ExampleStruct

Public static operator doc comments first line.

The assignment operator transfers the value of b to a, and returns a.

a:ExampleStructThe instance to update
b:ExampleStructThe instance to read from
returns
ExampleStruct

The first parameter is returned after being updated with the values of the second.

 

+()
static

public operator static function +(a:ExampleStruct, b:ExampleStruct):ExampleStruct

Public static operator doc comments first line.

The addition operator combines the values of b and a into a new instance.

See Also

a:ExampleStructThe left-hand operand
b:ExampleStructThe right-hand operand
returns
ExampleStruct

A new instance is returned, created from the sums of the x and y components of the operands.

 

+=()

public operator function +=(b:ExampleStruct):void

Public operator doc comments first line.

The addition with assignment operator combines the values of b into this instance.

See Also

b:ExampleStructThe right-hand operand to be added to this instance

 

 

 

 

 

 

 

 

 

 

lsdoc 2018 pixeldroid
https://github.com/pixeldroid/lsdoc
programming pages theme v0.5.10 (https://github.com/pixeldroid/programming-pages)