org.apache.flex.compiler.asdoc

Interface IASDocComment

All Known Implementing Classes:

ASDocComment, ASDocComment

public interface IASDocComment

Opaque interface used by IDocumentableDefinitionNodes and IDocumentableDefinitions to refer to ASDoc comments. As more ASDoc functionality is ported into the compiler code base, methods can be added to this interface to allow easier access to ASDoc information.

Method Summary

Methods

Modifier and Type	Method and Description
void	compile()
String	getDescription()
IASDocTag	getTag(String name)
Map<String,List<IASDocTag>>	getTags()
Collection<IASDocTag>	getTagsByName(String name)
boolean	hasTag(String name)
void	paste(IASDocComment source)

Method Detail

getDescription

String getDescription()

compile

void compile()

hasTag

boolean hasTag(String name)

getTag

IASDocTag getTag(String name)

getTags

Map<String,List<IASDocTag>> getTags()

getTagsByName

Collection<IASDocTag> getTagsByName(String name)

paste

void paste(IASDocComment source)