Ctrlk
Edit

Introduction

DocBox is a JavaDoc-style documentation generator for your BoxLang and CFML Applications.

📚 DocBox reads class metadata and structured comments and outputs documentation in an HTML, JSON, or UML (diagram) format. You can see our live docs here: https://s3.amazonaws.com/apidocs.ortussolutions.com/docbox/5.0.0/index.html

💻 System Requirements

  • BoxLang 1.8+

  • Lucee 5+ / Adobe ColdFusion 2023+ (CFML Support)

🔢 Versioning

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

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

💼 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

NextRelease History

Last updated

Was this helpful?