DocBox
  • Introduction
    • Release History
      • What's New With 4.1.0
      • What's New With 4.0.0
    • Contributing
  • Getting Started
    • Installation
    • Configuration
    • Annotating Your Code
  • Output Formats
    • HTML Output
    • JSON Output
      • JSON Schema
    • UML Output
    • Custom Output
Powered by GitBook
On this page
  • Using DocBox in a Standalone Application
  • Download
  • Mapping
  • Using DocBox
  • Using DocBox from the Command Line

Was this helpful?

Edit on GitHub
Export as PDF
  1. Getting Started

Installation

Just use CommandBox! No, really.

PreviousContributingNextConfiguration

Last updated 1 year ago

Was this helpful?

Using DocBox in a Standalone Application

Installing and using DocBox consists of three main steps:

Download

For best results, use 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.

Mapping

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.

Using DocBox

The final step to get DocBox running is to write a CFML script that initializes, configures, and runs DocBox against your application code.

See for more details.

Using DocBox from the Command Line

  1. Run box install commandbox-docbox to install the docbox command namespace

  2. Run docbox help to get a list of commands

  3. Run docbox generate help to show help for the docbox generate command

We also have a CommandBox module called which enables generating documentation from the CLI.

Please see the for more info.

CommandBox
Configuration
DocBox Commands,
DocBox Commands README