org.apache.flex.compiler.definitions

Interface IDocumentableDefinition

All Superinterfaces:

IDefinition

All Known Subinterfaces:

IAccessorDefinition, IAppliedVectorDefinition, IClassDefinition, IConstantDefinition, IEffectDefinition, IEventDefinition, IFunctionDefinition, IGetterDefinition, IInterfaceDefinition, IMemberedDefinition, IMetadataDefinition, INamespaceDefinition, INamespaceDefinition.IAnyNamespaceDefinition, INamespaceDefinition.ICodeModelImplicitDefinitionNamespaceDefinition, INamespaceDefinition.IFilePrivateNamespaceDefinition, INamespaceDefinition.IInterfaceNamespaceDefinition, INamespaceDefinition.IInternalNamespaceDefinition, INamespaceDefinition.ILanguageNamespaceDefinition, INamespaceDefinition.INamespaceWithPackageName, INamespaceDefinition.IPrivateNamespaceDefinition, INamespaceDefinition.IProtectedNamespaceDefinition, INamespaceDefinition.IPublicNamespaceDefinition, INamespaceDefinition.IStaticProtectedNamespaceDefinition, IPackageDefinition, IParameterDefinition, IScopedDefinition, ISetterDefinition, IStyleDefinition, ITypedClassNode, ITypeDefinition, IVariableDefinition, NamespaceDefinition.INamepaceDeclarationDirective

All Known Implementing Classes:

AccessorDefinition, AmbiguousDefinition, AppliedVectorDefinition, ASProjectScope.DefinitionPromise, ClassDefinition, ClassDefinitionBase, ClassTraitsDefinition, ConstantDefinition, DefinitionBase, EffectDefinition, EventDefinition, FunctionDefinition, GetterDefinition, InterfaceDefinition, MemberedDefinition, MetadataDefinitionBase, NamespaceDefinition, PackageDefinition, ParameterDefinition, ScopedDefinitionBase, SetterDefinition, StateDefinition, StateDefinitionBase, StateGroupDefinition, StyleDefinition, SyntheticBindableGetterDefinition, SyntheticBindableSetterDefinition, TypeDefinitionBase, VariableDefinition

public interface IDocumentableDefinition
extends IDefinition

The base class for definitions which can have ASDoc comments.

Method Summary

Methods

Modifier and Type	Method and Description
IASDocComment	getExplicitSourceComment() Gets the IASDocComment for the ASDoc comment attached to this IDocumentableDefinition.
boolean	hasExplicitComment() Determines if this node has an explicit comment.

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getEnd, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getNode, getPackageName, getParent, getQualifiedName, getSourcePath, getStart, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Method Detail

getExplicitSourceComment

IASDocComment getExplicitSourceComment()

Gets the IASDocComment for the ASDoc comment attached to this IDocumentableDefinition.

Returns:

The IASDocComment for the ASDoc comment attached to this IDocumentableDefinition.

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