org.apache.flex.compiler.asdoc

Interface IASDocDelegate

All Known Implementing Classes:

FlexJSASDocDelegate, NilASDocDelegate, SimpleASDocDelegate

public interface IASDocDelegate

Delegate interface used by the ASParser to record ASDoc information encountered while parsing ActionScript or meta-data tags.

Method Summary

Methods

Modifier and Type	Method and Description
IASDocComment	createASDocComment(ISourceLocation location, IDocumentableDefinition definition) Called by MXML tree building code to create an IASDocComment for classes defined by MXML files.
IASParserASDocDelegate	getASParserASDocDelegate() Get's an implementation of IASParserASDocDelegate that can be used by the ASParser to record information about ASDoc comments encountered while parsing ActionScript.
IPackageDITAParser	getPackageDitaParser() Get's an implementation of IPackageDITAParser that can be used by the SWCReader to parse DITA information found in a SWC.

Method Detail

getASParserASDocDelegate

IASParserASDocDelegate getASParserASDocDelegate()

Get's an implementation of IASParserASDocDelegate that can be used by the ASParser to record information about ASDoc comments encountered while parsing ActionScript.

Implementations of the IASParserASDocDelegate interface that record ASDoc data are stateful and can not be shared between ASParser instances.

Returns:

an implementation of IASParserASDocDelegate that can be used by the ASParser to recored information about ASDoc comments

createASDocComment

IASDocComment createASDocComment(ISourceLocation location,
                               IDocumentableDefinition definition)

Called by MXML tree building code to create an IASDocComment for classes defined by MXML files.

Parameters:

location - The location of the ASDoc text in an MXML file.

definition - The IDefinition the ASDoc documents

Returns:

A new IASDocComment or null.

getPackageDitaParser

IPackageDITAParser getPackageDitaParser()

Get's an implementation of IPackageDITAParser that can be used by the SWCReader to parse DITA information found in a SWC.

Returns:

An implementation of IPackageDITAParser.