From 0b8da47d021731b79605a252bfc8af9127220975 Mon Sep 17 00:00:00 2001 From: s7github Date: Thu, 22 Jan 2015 16:34:04 +0100 Subject: [PATCH 1/2] Update run.cfm Added example of how user can use recursive attribute --- run.cfm | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/run.cfm b/run.cfm index cdc952c..5382c55 100644 --- a/run.cfm +++ b/run.cfm @@ -7,7 +7,17 @@ Let's generate our default HTML documentation on myself: strategy = createObject("component", "colddoc.strategy.api.HTMLAPIStrategy").init(expandPath("./docs"), "ColdDoc 1.0"); colddoc.setStrategy(strategy); - colddoc.generate(expandPath("/colddoc"), "colddoc"); + // Let's give flexibility to user to make choice of the folders within application which need to be documented + rootFolder = expandPath("/"); + path_mapping = [ + , {inputDir="#rootFolder#", inputMapping="colddoc", recursive="false"} + , {inputDir="#rootFolder#\strategy\api", inputMapping="colddoc.strategy.api", recursive="true"} + ]; + + colddoc.generate(path_mapping); + + // Or diretly specify path and mapping to generate function + //colddoc.generate(expandPath("/colddoc"), "colddoc");

Done!

From 78ca646fdbca1e2d515a5b0bdf5cca1e90f4e852 Mon Sep 17 00:00:00 2001 From: s7github Date: Thu, 22 Jan 2015 16:34:13 +0100 Subject: [PATCH 2/2] Update ColdDoc.cfc Added recursive attribute so that user can specify which directories should not to be scanned recursively. --- ColdDoc.cfc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/ColdDoc.cfc b/ColdDoc.cfc index 40d20d8..fa59c60 100644 --- a/ColdDoc.cfc +++ b/ColdDoc.cfc @@ -13,6 +13,7 @@ + var qMetaData = 0; var source = 0; @@ -25,7 +26,7 @@ if(isSimpleValue(arguments.inputSource)) { - source = [{ inputDir=arguments.inputSource, inputMapping=arguments.inputMapping }]; + source = [{ inputDir=arguments.inputSource, inputMapping=arguments.inputMapping, recursive=arguments.recursive }]; } else { @@ -75,7 +76,7 @@ - +