org.apache.flex.swc.dita

Interface IDITAEntry

public interface IDITAEntry

An IDITAEntry represents a category of DITA data stored within in a SWC for a specific package

Method Summary

Methods

Modifier and Type	Method and Description
IASDocComment	getComment(IDefinition defintion) Returns the comment for the specific IDefinition if it exists.
String	getPackageName() Returns the package name that this IDITAEntry represents

Method Detail

getPackageName

String getPackageName()

Returns the package name that this IDITAEntry represents

getComment

IASDocComment getComment(IDefinition defintion)
                         throws Exception

Returns the comment for the specific IDefinition if it exists. If nothing exists, this method will return null

Parameters:

defintion - the IDefinition whose comment we want to find

Returns:

an IASDocComment or null

Throws:

Exception