org.apache.flex.compiler.tree.as

Interface IDocumentableDefinitionNode

All Superinterfaces:

IASNode, IDefinitionNode, ISourceLocation

All Known Subinterfaces:

IAccessorNode, IClassNode, ICommonClassNode, IEffectTagNode, IEventTagNode, IFunctionNode, IGetterNode, IInterfaceNode, IMXMLApplicationNode, IMXMLClassDefinitionNode, IMXMLDocumentNode, INamespaceNode, IParameterNode, ISetterNode, IStyleTagNode, IVariableNode

All Known Implementing Classes:

AccessorNode, BaseDefinitionMetaTagNode, BaseDefinitionNode, BaseTypedDefinitionNode, BaseVariableNode, ChainedVariableNode, ClassNode, ConfigConstNode, ConfigNamespaceNode, EffectTagNode, EventTagNode, FunctionNode, GetterNode, InterfaceNode, MemberedNode, MXMLClassDefinitionNode, MXMLDocumentNode, NamespaceNode, PackageNode, ParameterNode, SetterNode, StyleTagNode, VariableNode

public interface IDocumentableDefinitionNode
extends IDefinitionNode

An AST node representing a declaration that can have an ASDoc comment associated with it.

The comment must come directly before the definition.

Field Summary

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
IASDocComment	getASDocComment() Gets the IASDocComment attached to this IDocumentableDefinitionNode.
boolean	hasExplicitComment() Determines if this node has an explicit comment.

Methods inherited from interface org.apache.flex.compiler.tree.as.IDefinitionNode

getContainingFilePath, getDefinition, getMetaInfos, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getPackageName, getQualifiedName, getShortName, hasModifier, hasNamespace, isImplicit

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getNodeID, getParent, getSpanningStart, getSucceedingNode, isTerminal

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Method Detail

getASDocComment

IASDocComment getASDocComment()

Gets the IASDocComment attached to this IDocumentableDefinitionNode.

Returns:

The IASDocComment attached to this IDocumentableDefinitionNode.

hasExplicitComment

boolean hasExplicitComment()

Determines if this node has an explicit comment. Since comments can inherit, the value from getComment might not always be defined on the element itself

Returns:

true if we have an explicit comment