FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...
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
Apache License, Version 2.0.
Install the commands via CommandBox like so:
box install commandbox-docbox
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
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"
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
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
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.