Book HomeActionScript: The Definitive GuideSearch this book

20.4. Entry Headings

The headings used to document each item of the Language Reference are described in Table 20-3.

Table 20-3. Language Reference Headings

Heading

Description

Availability

Indicates when the item was added to ActionScript (or became an Action, if the item predates formal ActionScript). Also summarizes backward-compatibility and deprecation status.

Synopsis

Illustrates the abstract syntax required by the item. Italicized code indicates text that must be provided by the programmer.

Arguments

Applies to method and function entries only. Describes the parameters used with the method or function, as listed in the Synopsis.

Returns

Applies to method and function entries only. Describes the return value of the method, if any. If the method does not have a return value, this heading is omitted.

Access

Applies to property entries only. Describes whether the property value may be retrieved ("Read-only") or both retrieved and assigned ("Read/write").

Description

Explains how the item works and how it might be used in a practical scenario.

Usage

Describes noteworthy peculiarities of the item.

Bugs

Describes known problems associated with the item.

Example

Offers sample code showing the item in use.

See Also

Lists cross-references to related topics.



Library Navigation Links

Copyright © 2002 O'Reilly & Associates. All rights reserved.