org.apache.flex.compiler.internal.parsing.as

Class SimpleASDocDelegate

java.lang.Object

org.apache.flex.compiler.internal.parsing.as.SimpleASDocDelegate

All Implemented Interfaces:

IASDocDelegate

public final class SimpleASDocDelegate
extends Object
implements IASDocDelegate

Default implementation of IASDocDelegate that does not have any code model or eclipse dependencies.

Constructor Summary

Constructors

Constructor and Description
SimpleASDocDelegate()

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.
static IASDocDelegate	get() Gets the single instance of this delegate.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleASDocDelegate

public SimpleASDocDelegate()

Method Detail

get

public static IASDocDelegate get()

Gets the single instance of this delegate.

Returns:

The single instance of this delegate.

getASParserASDocDelegate

public IASParserASDocDelegate getASParserASDocDelegate()

Description copied from interface: IASDocDelegate

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.

Specified by:

getASParserASDocDelegate in interface IASDocDelegate

Returns:

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

createASDocComment

public IASDocComment createASDocComment(ISourceLocation location,
                               IDocumentableDefinition definition)

Description copied from interface: IASDocDelegate

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

Specified by:

createASDocComment in interface IASDocDelegate

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

public IPackageDITAParser getPackageDitaParser()

Description copied from interface: IASDocDelegate

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

Specified by:

getPackageDitaParser in interface IASDocDelegate

Returns:

An implementation of IPackageDITAParser.