Skip to content

Commit c40c95d

Browse files
committed
updated scripts to use new command box dependency approach and also use new docbox generation
1 parent 0321c44 commit c40c95d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+86
-16509
lines changed

apidocs/Application.cfc

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
component{
22

3-
this.name = "colddoc_" & hash(getCurrentTemplatePath());
3+
this.name = "APIDocs" & hash(getCurrentTemplatePath());
44
this.sessionManagement = true;
55
this.sessionTimeout = createTimeSpan(0,0,1,0);
66

7-
// mappings
8-
this.mappings[ "/colddoc" ] = getDirectoryFromPath( getCurrentTemplatePath() );
7+
// API Root
8+
API_ROOT = getDirectoryFromPath( getCurrentTemplatePath() );
9+
rootPath = REReplaceNoCase( API_ROOT, "apidocs(\\|\/)$", "" );
910

10-
rootPath = REReplaceNoCase( this.mappings[ "/colddoc" ], "apidocs(\\|\/)$", "" );
11-
this.mappings[ "/root" ] = rootPath;
12-
this.mappings[ "/cbdebugger" ] = rootPath & "modules/cbdebugger/models";
13-
14-
// request start
15-
public boolean function onRequestStart(String targetPage){
16-
return true;
17-
}
11+
this.mappings[ "/docbox" ] = API_ROOT & "docbox";
12+
this.mappings[ "/root" ] = rootPath;
13+
this.mappings[ "/cbdebugger" ] = rootPath & "modules/cbdebugger/models";
1814

1915
}

apidocs/ColdDoc.cfc

Lines changed: 0 additions & 263 deletions
This file was deleted.

apidocs/README.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

apidocs/box.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name":"API Docs",
3+
"version":"1.0.0",
4+
"slug":"module-apidocs",
5+
"private":true,
6+
"defaultPort":8511,
7+
"dependencies":{
8+
"docbox":"https://github.com/Ortus-Solutions/DocBox/archive/v2.0.4.zip"
9+
},
10+
"devDependencies":{
11+
12+
},
13+
"installPaths":{
14+
"docbox":"docbox"
15+
},
16+
"ignore":[
17+
"**/.*",
18+
"tests"
19+
]
20+
}

apidocs/index.cfm

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
<cfparam name="url.version" default="0">
2-
<cfparam name="url.path" default="#expandPath( "./CBDebugger-APIDocs" )#">
2+
<cfparam name="url.path" default="#expandPath( "./cbdebugger-APIDocs" )#">
33
<cfscript>
4-
docName = "CBDebugger-APIDocs";
5-
base = expandPath( "/cbdebugger" );
6-
7-
colddoc = new ColdDoc();
8-
strategy = new colddoc.strategy.api.HTMLAPIStrategy( url.path, "CBDebugger v#url.version#" );
9-
colddoc.setStrategy( strategy );
10-
11-
colddoc.generate( inputSource=base, outputDir=url.path, inputMapping="cbdebugger" );
4+
docName = "cbdebugger-APIDocs";
5+
base = expandPath( "/cbdebugger" );
6+
docbox = new docbox.DocBox( properties = {
7+
projectTitle = "cbdebugger v#url.version#",
8+
outputDir = url.path
9+
} );
10+
docbox.generate( source=base, mapping="cbdebugger" );
1211
</cfscript>
1312

1413
<!---

0 commit comments

Comments
 (0)