Installing and using DocBox consists of three main steps:
For best results, use CommandBox to run
box install docbox --saveDev in your app root.
Alternatively, you can download the DocBox source code and drop it into a
docbox folder in your application.
If DocBox is not installed in the root of your application, you will need to create a
docbox mapping that points to the DocBox source code location:
this.mappings[ "docbox" ] = expandPath( "./libraries/doctorBox" );
In addition to the Docbox mapping, you will need a Coldfusion server mapping for each source code location. For example, documenting a component with
implements="cbsecurity.interfaces.IAuthService" will require a mapping of
cbsecurity to the installed
cbsecurity source code so DocBox can find the referenced interface.
The final step to get DocBox running is to write a CFML script which initializes, configures, and runs DocBox against your application code.
See Configuration for more details.
We also have a CommandBox module called DocBox Commands which enables generating documentation from the CLI.
box install commandbox-docbox to install the
docbox command namespace
docbox help to get a list of commands
docbox generate help to show help for the
docbox generate command
Please see the DocBox Commands README for more info.