Using the @see tag

The @see tag lets you create cross-references to elements within a class; to elements in other classes in the same package; and to other packages. You can also cross-reference URLs outside ASDoc. The @see tag has the following syntax:

@see reference [displayText]

where reference specifies the destination of the link, and displayText optionally specifies the link text. The location of the destination of the @see tag is determined by the prefix to the reference attribute:

  • # ASDoc looks in the same class for the link destination.

  • ClassName ASDoc looks in a class in the same package for the link destination.

  • PackageName ASDoc looks in a different package for the link destination.

  • effect ASDoc looks for an effect property for the link destination.

  • event ASDoc looks for an event property for the link destination.

  • style ASDoc looks for a style property for the link destination.

Note: You cannot insert HTML tags in reference. However, you can add an HTML link without using the @see tag by inserting the HTML code in the ASDoc comment.
The following table shows several examples of the @see tag:

Example

Result

 
@see "Just a label"

Text string

 
@see http://www.cnn.com

External web site

 
@see package-detail.html

Local HTML file

 
@see AccessibilityProperties

Class in same package

 
@see flash.display.TextField

Class in different package

 
@see flash.ui.ContextMenu#customItems

Property in class in different package

 
@see mx.containers.DividedBox#style:dividerAffordance

Style property in class in different package

 
@see #updateProperties()

Method in same class as @see tag

 
@see flash.ui.ContextMenu#clone()

Method in class in different package

 
@see flash.util.#clearInterval()

Package method in flash.util

@see mx.controls.Buttont#style:horizontalGap

Style property in Button class.

@see mx.containers.Accordion#event:change

Event in Accordion class.

@see mx.core.UIComponent#effect:creationCompleteEffect

Effect property in UIComponent class.