FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

CommandBox DocBox Commands

v1.3.2 Public

DocBox Commands

DocBox Commands is a custom command you can install into CommandBox to generate API docs from the commandline. 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

LICENSE

Apache License, Version 2.0.

SYSTEM REQUIREMENTS

  • CommandBox 2.5+

Installation

Install the commands via CommandBox like so:

box install commandbox-docbox

Usage

Creates documentation for CFCs JavaDoc style via DocBox

You can pass the strategy options by prefixing them with strategy-. So if a strategy takes in a property of outputDir you will pass it as strategy-outputdir=

Examples:

docbox generate source=/path/to/coldbox mapping=coldbox excludes=tests strategy-outputDir=/output/path strategy-projectTitle="My Docs"

Multiple mappings may be specified, where the key is the mapping and the value is the source directory. For example, the following generates documentation for two different versions of a model:

docbox generate mappings:v1.models=/path/to/modules_app/v1/models mappings:v2.models=/path/to/modules_app/v2/models strategy-outputDir=/output/path strategy-projectTitle="My Docs"

Arguments:

  • strategy - The strategy class to use to generate the docs.
  • source - The directory containing the CFML source.
  • mapping - The base mapping for the source folder.
  • excludes - A regex that will be applied to the input source to exclude from the docs.
  • mappings:* - One or more dynamic parameters defining source and mapping. This argument will override source and mapping if provided.

CREDITS & CONTRIBUTIONS

I THANK GOD FOR HIS WISDOM FOR THIS PROJECT

THE DAILY BREAD

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

CHANGELOG

1.0.0

  • Initial creation of separate CommandBox project

Here are all the versions for this package. Please note that you can leverage CommandBox package versioning to install any package you like. Please refer to our managing package version guide for more information.

Version Created Last Update Published By Stable Actions
Current
1.3.2 Aug 08 2018 10:46 PM Aug 08 2018 10:46 PM
Version History
1.3.0 Aug 03 2018 02:14 PM Aug 03 2018 02:14 PM
1.0.1 Oct 24 2017 05:49 PM Oct 24 2017 05:49 PM
1.0.0 Jan 18 2016 11:17 PM Jun 09 2016 01:17 AM

 

No collaborators yet.
     
  • Jan 18 2016 11:17 PM
  • Aug 08 2018 10:46 PM
  • 1161
  • 466
  • 6106