org.apache.royale.compiler.asdoc

Interface IASParserASDocDelegate

public interface IASParserASDocDelegate

Interface used by the ASParser to record ASDoc information.

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

Method Summary

Modifier and Type	Method and Description
IASDocComment	afterDefinition(IDocumentableDefinitionNode definitionNode) Called by the ASParser after an IDocumentableDefinitionNode has been constructed and fully parsed.
void	afterVariable()
void	beforeVariable() Called by the ASParser before a variable is parsed.
IMetadataParserASDocDelegate	getMetadataParserASDocDelegate() Called by the ASParser to get an implementation of IMetadataParserASDocDelegate that will be used by the MetadataParser to record information about ASDoc comments encountered while parsing ActionScript meta-data.
void	setCurrentASDocToken(antlr.Token asDocToken) Called by the ASParser whenever a Token containing an ASDoc comment is encountered.

Method Detail

beforeVariable

void beforeVariable()

Called by the ASParser before a variable is parsed.

This is here to handle cases like this:

 /**
  * Documentation for variable a.
  */
 var a:*,b:* = function () {
 
  var var_that_is_not_documented : *;
  }
 

The easiest way to handle the above case is to push the current ASDoc state on to a stack and pop it off that stack when afterVariable() is called.

afterVariable

void afterVariable()

See Also:

beforeVariable()

setCurrentASDocToken

void setCurrentASDocToken(antlr.Token asDocToken)

Called by the ASParser 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 ASParser 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.

getMetadataParserASDocDelegate

IMetadataParserASDocDelegate getMetadataParserASDocDelegate()

Called by the ASParser to get an implementation of IMetadataParserASDocDelegate that will be used by the MetadataParser to record information about ASDoc comments encountered while parsing ActionScript meta-data.

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

Returns:

An implementation of IMetadataParserASDocDelegate that will be used by the MetadataParser to record information about ASDoc comments encountered while parsing ActionScript meta-data.