██████╗  ██████╗  ██████╗██████╗  ██████╗ ██╗  ██╗
██╔══██╗██╔═══██╗██╔════╝██╔══██╗██╔═══██╗╚██╗██╔╝
██║  ██║██║   ██║██║     ██████╔╝██║   ██║ ╚███╔╝ 
██║  ██║██║   ██║██║     ██╔══██╗██║   ██║ ██╔██╗ 
██████╔╝╚██████╔╝╚██████╗██████╔╝╚██████╔╝██╔╝ ██╗
╚═════╝  ╚═════╝  ╚═════╝╚═════╝  ╚═════╝ ╚═╝  ╚═╝

DocBox is a fork of the ColdDoc project originally created by Mark Mandel. Documentation for DocBox can be found on the GitHub Wiki and in this Readme. The main Git repository and downloads can be found on GitHub. There is also a help forum located at https://groups.google.com/a/ortussolutions.com/forum/#!forum/docbox

Apache License, Version 2.0.

Please use our Jira instance to create bugs and new feature issues: https://ortussolutions.atlassian.net/projects/DOCBOX

• Lucee 4.5+
• ColdFusion 10+

Use the DocBox library to generate API docs from your CFC files. Install Docbox with CommandBox like so:

box install docbox

If you want to use DocBox for document generation in your CFML application, then just drop it into any location and create a /docbox mapping to it. You will then instantiate the DocBox generator class with a strategy and properties for the strategy.

// signature
docbox = new DocBox( strategy="class.path", properties={} );

// create with default strategy
docbox = new DocBox( properties = { 
    projectTitle="My Docs", 
    outputDir="#expandPath( '/docs' )#"
});

To generate the documentation you will then execute the generate() method on the DocBox object and pass in the following parameters:

• source : A path to the source location or an array of structs of locations that must have a dir and mapping key on it.
• mapping : The base mapping for the folder source. Used only if source is a path
• excludes : A regular expression that will be evaluated against all CFCs sent for documentation. If the regex matches the CFC name and path then the CFC will be excluded from documentation.

docbox.generate( source="/my/path", mapping="coldbox" );

docbox.generate(
    source  = "#expandPath( '/docbox' )",
    mapping = "coldbox",
    excludes = "tests"
);

Once the generation finalizes, you will see your beautiful docs!

• docbox.strategy.api.HTMLAPIStrategy - default
  • projectTitle : The HTML title
  • outputDir : The output directory
• docbox.strategy.uml2tools.XMIStrategy
  • outputFile : The output file

There is a related project you can install which wraps up the DocBox libraray in a Custom CLI command so you can generate API docs from the command line.

box install commandbox-docbox

Read more here: https://github.com/Ortus-Solutions/commandbox-docbox

Thanks to Mark Mandel for allowing us to fork his project.

I THANK GOD FOR HIS WISDOM FOR THIS PROJECT

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12