Installation
Just use CommandBox! No, really.
Installing and using DocBox consists of three main steps:
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 installedcbsecurity
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.
We also have a CommandBox module called DocBox Commands which enables generating documentation from the CLI.
- 1.Run
box install commandbox-docbox
to install thedocbox
command namespace - 2.Run
docbox help
to get a list of commands - 3.Run
docbox generate help
to show help for thedocbox generate
command
Last modified 2yr ago