org.apache.flex.compiler.asdoc

Interface IASDocBundleDelegate

public interface IASDocBundleDelegate

Delegate interface used by ASProject to delegate queries of the ASDoc bundle files to clients.

ASDoc bundles are resource bundle SWCs that contain DITA files with localized ASDoc information.

Field Summary

Fields

Modifier and Type	Field and Description
static IASDocBundleDelegate	NIL_DELEGATE A default implementation of IASDocBundleDelegate.

Method Summary

Methods

Modifier and Type	Method and Description
IASDocComment	getComment(IDocumentableDefinition definition, String containingSWCFileName) Retrieves the localized IASDocComment for the specified IDocumentableDefinition in the specified SWC file.

Field Detail

NIL_DELEGATE

static final IASDocBundleDelegate NIL_DELEGATE

A default implementation of IASDocBundleDelegate.

Method Detail

getComment

IASDocComment getComment(IDocumentableDefinition definition,
                       String containingSWCFileName)

Retrieves the localized IASDocComment for the specified IDocumentableDefinition in the specified SWC file.

Parameters:

definition - The IDocumentableDefinition whose comment is to be returned.

containingSWCFileName - The file name of the SWC containing the specified definition.

Returns:

A IASDocComment for the specified definition in the specified SWC file, localized for the current locale of the JVM, or null if there is no comment.