Introduction

DocBox is a JavaDoc-style documentation generator for your ColdFusion (CFML) codebase

DocBox reads component metadata and structured comments and outputs documentation in an HTML, JSON, or UML (diagram) format.

SYSTEM REQUIREMENTS

• Lucee 5+

• Adobe ColdFusion 2018+

Versioning

DocBox is maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered in the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

• Breaking backward compatibility bumps the major (and resets the minor and patch)

• New additions without breaking backward compatibility bumps the minor (and resets the patch)

• Bug fixes and misc changes bumps the patch

License

Apache 2 License: http://www.apache.org/licenses/LICENSE-2.0​

Important Links

• Code: https://github.com/ortus-solutions/docbox​

• Issues: https://ortussolutions.atlassian.net/jira/software/c/projects/DOCBOX/issues/

• Community: https://community.ortussolutions.com/

Professional Open Source

Ortus Solutions, Corp

DocBox is professional open source software backed by Ortus Solutions, Corp offering services like:

• Custom Development

• Professional Support & Mentoring

• Training

• Server Tuning

• Security Hardening

• Code Reviews

• Much More

HONOR GOES TO GOD ABOVE ALL

Because of His grace, this project exists. If you don't like this, don't read it; it's not for you.

"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God." Romans 5:5