Callable

Class

ColdDoc 1.0

FRAMES

colddoc.strategy.api
Class HTMLAPIStrategy

WEB-INF.cftags.component
        colddoc.strategy.AbstractTemplateStrategy
            colddoc.strategy.api.HTMLAPIStrategy

public class HTMLAPIStrategy
extends AbstractTemplateStrategy
extends AbstractTemplateStrategy

Default Document Strategy for ColdDoc

Constructor Summary
`init(string outputDir, [string projectTitle='Untitled'])` Constructor

Method Summary
`private void`	`buildClassPages(query qPackage, query qMetadata)` builds the class pages
`private string`	`getOutputDir()`
`private string`	`getProjectTitle()`
`void`	`run(query qMetadata)` Run this strategy
`private void`	`setOutputDir(string outputDir)`
`private void`	`setProjectTitle(string projectTitle)`
`private void`	`writeAllClassesFrame(query qMetadata)` writes the allclasses-frame
`private void`	`writeOverviewSummaryAndFrame(query qMetadata)` writes the overview-summary
`private void`	`writePackagePages(query qMetadata)` writes the package summaries

Methods inherited from class colddoc.strategy.AbstractTemplateStrategy
`_dump, _trace, buildFunctionMetaData, buildPackageTree, classExists, ensureDirectory, getFunctionQueryCache, getGenericTypes, getMetaSubQuery, getObjectName, getPackage, getPropertyMeta, isAbstractClass, isPrimitive, recursiveCopy, resolveClassName, safeFunctionMeta, safeParamMeta, setFunctionQueryCache, typeExists, visitPackageTree, writeTemplate`

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(string outputDir, [string projectTitle='Untitled'])

Constructor

Parameters:: outputDir - the output directory; projectTitle - the title of the project

Method Detail

buildClassPages

private void buildClassPages(query qPackage, query qMetadata)

builds the class pages

getOutputDir

private string getOutputDir()

getProjectTitle

private string getProjectTitle()

run

public void run(query qMetadata)

Run this strategy

setOutputDir

private void setOutputDir(string outputDir)

Parameters:: outputDir

setProjectTitle

private void setProjectTitle(string projectTitle)

Parameters:: projectTitle

writeAllClassesFrame

private void writeAllClassesFrame(query qMetadata)

writes the allclasses-frame.html

writeOverviewSummaryAndFrame

private void writeOverviewSummaryAndFrame(query qMetadata)

writes the overview-summary.html

writePackagePages

private void writePackagePages(query qMetadata)

writes the package summaries

Overview

Package