org.apache.royale.compiler.asdoc

Interface IMetadataParserASDocDelegate

public interface IMetadataParserASDocDelegate

Interface used by the MetadataParser to recored information about ASDoc comments encountered while parsing meta-data.

Implementations of this interface that record ASDoc data are stateful and can not be shared between MetadataParser instances.

Method Summary

Modifier and Type	Method and Description
IASDocComment	afterDefinition(IDocumentableDefinitionNode definitionNode) Called by the MetadataParser after an IDocumentableDefinitionNode has been constructed and fully parsed.
void	afterMetadata(int metaDataEndOffset) Called by the MetadataParser any time a meta-data tag is parsed.
void	clearMetadataComment(String metaDataTagName) Called by the MetadataParser after parsing a meta-data tag that should prevent the current ASDoc comment from attaching to any subsequent meta-data tag.
void	setCurrentASDocToken(antlr.Token asDocToken) Called by the MetadataParser whenever a Token containing an ASDoc comment is encountered.

Method Detail

setCurrentASDocToken

void setCurrentASDocToken(antlr.Token asDocToken)

Called by the MetadataParser whenever a Token containing an ASDoc comment is encountered.

Parameters:

asDocToken - A Token containing an ASDoc comment.

afterDefinition

IASDocComment afterDefinition(IDocumentableDefinitionNode definitionNode)

Called by the MetadataParser after an IDocumentableDefinitionNode has been constructed and fully parsed.

Parameters:

definitionNode - IDocumentableDefinitionNode that has been parsed.

Returns:

An IASDocComment that should be attached to the IDocumentableDefinitionNode.

clearMetadataComment

void clearMetadataComment(String metaDataTagName)

Called by the MetadataParser after parsing a meta-data tag that should prevent the current ASDoc comment from attaching to any subsequent meta-data tag.

Parameters:

metaDataTagName - The name of the meta-data tag prevents the current ASDoc comment from attaching to any subsequent meta-data tag.

afterMetadata

void afterMetadata(int metaDataEndOffset)

Called by the MetadataParser any time a meta-data tag is parsed.

Parameters:

metaDataEndOffset - The end offset of the meta-data tag that has been parsed.