lucee.Componentdocbox.DocBox
Core DocBox documentation class
Copyright 2015 Ortus Solutions, Corp www.ortussolutions.com
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any<AbstractTemplateStrategy>
|
strategy
The strategy to use for document generation.
|
true
|
false
|
Constructor Summary | |
---|---|
init([any strategy='docbox.strategy.api.HTMLAPIStrategy'], [struct properties='[runtime expression]'])
Constructor. |
Method Summary | |
---|---|
query
|
buildMetaDataCollection(array inputSource, [string excludes=''])
Builds the searchable meta data collection. |
private any
|
cleanPath(any path, any inputDir)
Clean input path. |
DocBox
|
generate(any source, [string mapping=''], [string excludes=''])
Generate the docs. |
private array
|
getImplements(struct metadata)
Gets an array of the classes that this metadata implements, in order of extension. |
private array
|
getInheritance(struct metadata)
Gets an array of the classes that this metadata extends, in order of extension. |
string
|
getStrategy()
|
any
|
setStrategy(any strategy)
|
any
|
testFunction([any param1], [any param2])
Undocumented function. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor we create the default strategy of 'docbox.strategy.api.HTMLAPIStrategy'
strategy
- The optional strategy to generate the documentation with. This can be a class path or an instance of the strategy. If none is passed thenproperties
- The struct of properties to instantiate the strategy with.Property Detail |
---|
The strategy to use for document generation. Must extend docbox.strategy.AbstractTemplateStrategy
access
- publicrequired
- falsereturntype
- anydoc_generic
- docbox.strategy.AbstractTemplateStrategyserializable
- trueMethod Detail |
---|
Builds the searchable meta data collection
inputSource
- an array of structs containing inputDir and mappingexcludes
- A regex that will be applied to the input source to exclude from the docsClean input path
path
- The incoming path to cleaninputDir
- The input dir to clean offGenerate the docs
source
- Either, the string directory source, OR an array of structs containing 'dir' and 'mapping' keymapping
- The base mapping for the folder. Only required if the source is a stringexcludes
- A regex that will be applied to the input source to exclude from the docsGets an array of the classes that this metadata implements, in order of extension
metadata
- The metadata to look atGets an array of the classes that this metadata extends, in order of extension
metadata
- The metadata to look atstrategy
Undocumented function
param1
- param 1param2
- param 2