General asdoc informations

ASDoc is a command-line tool part of the Flex SDK.

Special Characters

char	asdoc	comment
<	&lt;
>	&gt;
&	&#38;	do not use &amp;
#	&#35;
*	&#42;
?	&#x2014;	Em dash
™	&#x99;	Trademark symbol
	&#xA0;	Nonbreaking space
®	&#xAE;	Registered trademark symbol
°	&#xB0;	Degree symbol
@	&#64;

Standard Tags

@copy reference

Copies an ASDoc comment from the referenced location.

/**
 * @copy #stop
 */
public function terminate():void
{
    //...
}

@default value

test

@eventType package.class.CONSTANT
@eventType String

test

@example exampleText

test

@exampleText string

test

@includeExample textFile

test

@inheritDoc

test

@internal text

test

@param name description

test

@private

test

@return description

test

@see reference [text]

test

tag usage	description
@see "some text"	text string
@see http://www.google.com	external web site
@see http://www.google.com Visit Google	external web site with text description
@see https://www.google.com	HTTPS link will not work
@see page.html	local HTML page
@see SomeClass	class in same package
@see flash.display.TextField	class in different package
@see flash.display.TextField TextField	class in different package with text description
@see String	top level class
@see String#charCodeAt()	method in top level class
@see String#charCodeAt() String.charCodeAt()	method in top level class with text description
@see #someMethod()	method in same class of see tag
@see flash.utils.#clearInterval()	package level function
@see flash.ui.ContextMenu#customItems	property in class in different package
@see C.stdio#EOF	package level constant
@see C.stdio#EOF EOF	package level constant with text description

@since text

test

@throws package.class.className description

test

Undocumented Tags

@langversion text

@playerversion name [text]

Metadata

[Deprecated]

syntax:

[Deprecated(message="some reason why",replacement="something",since="foobar")]

• message (optional)
  indicate a message for the deprecation
• replacement (optional)
  indicate another method or property or class as a replacement
• since (optional)
  allow to indicate since which version or product or time it is deprecated

notes:

If you use the message argument then you can not use replacement.

For replacement you can use

• a method in the same class
  [Deprecated(replacement="otherMethod()")
• a class name (in the same package) followed by a method
  [Deprecated(replacement="MyOtherClass.somethingElse()")

usage:

• no arguments

[Deprecated]
var property:String = "foobar;

will display in the documentation

<b>Deprecated:</b> Deprecated

• message argument only

[Deprecated(message="some reason why")]
var property:String = "foobar;

will display in the documentation

<b>Deprecated:</b> some reason why

• message and since arguments

[Deprecated(message="some reason why",since="2018/01/23: ")]
var property:String = "foobar;

will display in the documentation

<b>Deprecated Since</b> 2018/01/23: some reason why

Note:
Yes you will need to manually add the spacing in the since argument

• replacement argument only

[Deprecated(replacement="something")]
var property:String = "foobar;

will display in the documentation

<b>Deprecated:</b> Please Use <a href="#something">something</a>

• since argument only

[Deprecated(since="foobar")]
var property:String = "foobar;

will display in the documentation

<b>Deprecated Since</b> foobar

• replacement and since arguments

[Deprecated(replacement="something",since="foobar")]
var property:String = "foobar;

will display in the documentation

<b>Deprecated Since</b> foobar: Please Use <a href="#something">something</a>