|
ColdDoc 1.0 | ||||
FRAMES |
WEB-INF.cftags.component colddoc.ColdDoc
public class ColdDoc
Core class for ColdDoc documentation generation framework
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
_dump([any s], [any abort='true'])
|
any |
_trace([any s])
|
private query |
buildMetaDataCollection(array inputSource)
builds the searchable meta data collection |
void |
generate(any inputSource, [string inputMapping=''])
generates the documentation |
private array |
getImplements(struct metadata)
gets an array of the interfaces that this metadata implements |
private array |
getInheritence(struct metadata)
gets an array of the classes that this metadata extends, in order of extension |
any<AbstractTemplateStrategy> |
getStrategy()
Returns the current document templating strategy that is being userd |
boolean |
hasStrategy()
whether this object has a strategy |
void |
setStrategy(any<AbstractTemplateStrategy> strategy)
Set the document templating strategy that is going to be used |
private any |
throwException(string type, string message, [string detail=''])
Throws an Exception |
private void |
warnError(string cfcName, any error)
Warn the user that there was an error through cftrace |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init()
Method Detail |
---|
public any _dump([any s], [any abort='true'])
s
abort
public any _trace([any s])
s
private query buildMetaDataCollection(array inputSource)
inputSource
- an array of structs containing inputDir and inputMappingpublic void generate(any inputSource, [string inputMapping=''])
inputSource
- either, the string directory source, OR an array of structs containing inputDir and inputMapping keyinputMapping
- the base mapping for the folder. Only required if the inputSource is a string.private array getImplements(struct metadata)
metadata
- the metadata to look atprivate array getInheritence(struct metadata)
metadata
- the metadata to look atpublic any<AbstractTemplateStrategy> getStrategy()
public boolean hasStrategy()
public void setStrategy(any<AbstractTemplateStrategy> strategy)
strategy
- The strategy object that is called to generate the doc. Usually extends colddoc.strategy.AbstractTemplateStrategy.private any throwException(string type, string message, [string detail=''])
type
- The type of exceptionmessage
- The message to accompany the exceptiondetail
- The detail message for the exceptionprivate void warnError(string cfcName, any error)
cfcName
- the name of the cfcerror
- the error struct
|
ColdDoc 1.0 | ||||
FRAMES |