lucee.Componentdocbox.strategy.AbstractTemplateStrategy
testbox.apidocs.docbox.strategy.api.HTMLAPIStrategy
Default Document Strategy for DocBox
Copyright 2015 Ortus Solutions, Corp www.ortussolutions.com
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
string
|
outputDir
The output directory.
|
true
|
false
|
|
string
|
projectTitle
The project title to use.
|
Untitled
|
true
|
false
|
Constructor Summary | |
---|---|
init(any outputDir, [string projectTitle='Untitled'])
Constructor. |
Method Summary | |
---|---|
HTMLAPIStrategy
|
buildClassPages(query qPackage, query qMetadata)
builds the class pages. |
string
|
getOutputDir()
|
string
|
getProjectTitle()
|
HTMLAPIStrategy
|
run(query qMetadata)
Run this strategy. |
any
|
setOutputDir(string outputDir)
|
any
|
setProjectTitle(string projectTitle)
|
HTMLAPIStrategy
|
writeAllClassesFrame(query qMetadata)
writes the allclasses-frame. |
HTMLAPIStrategy
|
writeOverviewSummaryAndFrame(query qMetadata)
writes the overview-summary. |
HTMLAPIStrategy
|
writePackagePages(query qMetadata)
writes the package summaries. |
Methods inherited from class docbox.strategy.AbstractTemplateStrategy |
---|
buildFunctionMetaData, buildPackageTree, buildPropertyMetaData, classExists, ensureDirectory, getFunctionQueryCache, getGenericTypes, getMetaSubQuery, getObjectName, getPackage, getPropertyMeta, getPropertyQueryCache, isAbstractClass, isPrimitive, resolveClassName, safeFunctionMeta, safeParamMeta, safePropertyMeta, setFunctionQueryCache, setPropertyQueryCache, typeExists, visitPackageTree, writeTemplate |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
outputDir
- The output directoryprojectTitle
- The title used in the HTML outputProperty Detail |
---|
The output directory
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe project title to use
access
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
builds the class pages
qPackage
- the query for a specific packageqMetadata
- The metadataRun this strategy
run
in class
docbox.strategy.AbstractTemplateStrategy
qMetadata
- The metadataoutputDir
projectTitle
writes the allclasses-frame.html
qMetadata
- The metadatawrites the overview-summary.html
qMetadata
- The metadatawrites the package summaries
qMetadata
- The metadata