Overview  Package   Class 
ColdDoc 1.0 Alpha
FRAMES  

colddoc
Class ColdDoc

WEB-INF.cftags.component
        extended by colddoc.ColdDoc

public class ColdDoc

extends WEB-INF.cftags.component

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
 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

init

public init()
Constructor

Method Detail

_dump

public any _dump([any s], [any abort='true'])

Parameters:
s
abort

_trace

public any _trace([any s])

Parameters:
s

buildMetaDataCollection

private query buildMetaDataCollection(array inputSource)
builds the searchable meta data collection

Parameters:
inputSource - an array of structs containing inputDir and inputMapping

generate

public void generate(any inputSource, [string inputMapping=''])
generates the documentation

Parameters:
inputSource - either, the string directory source, OR an array of structs containing inputDir and inputMapping key
inputMapping - the base mapping for the folder. Only required if the inputSource is a string.

getStrategy

public any<AbstractTemplateStrategy> getStrategy()
Returns the current document templating strategy that is being userd

hasStrategy

public boolean hasStrategy()
whether this object has a strategy

setStrategy

public void setStrategy(any<AbstractTemplateStrategy> strategy)
Set the document templating strategy that is going to be used

Parameters:
strategy - The strategy object that is called to generate the doc. Usually extends colddoc.strategy.AbstractTemplateStrategy.

throwException

private any throwException(string type, string message, [string detail=''])
Throws an Exception

Parameters:
type - The type of exception
message - The message to accompany the exception
detail - The detail message for the exception

warnError

private void warnError(string cfcName, any error)
Warn the user that there was an error through cftrace

Parameters:
cfcName - the name of the cfc
error - the error struct
Overview  Package   Class 
ColdDoc 1.0 Alpha
FRAMES