boxlang-docboxlisted

# DocBox — API Documentation Generator ## Overview DocBox automatically parses your BoxLang or CFML source code and generates browsable API documentation in multiple output formats. It reads JavaDoc-style `/** ... */` comments, class/property/function metadata, and inheritance relationships. **Published docs:** https://docbox.ortusbooks.com --- ## Installation ### BoxLang Module (Recommended) ```bash # CommandBox web runtimes box install bx-docbox # BoxLang OS runtime install-bx-module bx-docbox ``` ### CommandBox Module ```bash box install commandbox-docbox --saveDev ``` ### CFML Application ```bash # Install via CommandBox into your project box install docbox --saveDev ``` Add a mapping if DocBox is not in the app root: ```javascript // Application.bx / Application.cfc this.mappings[ "/docbox" ] = expandPath( "./libraries/docbox" ); ``` --- ## CLI Usage (BoxLang, New in 5.0) The `boxlang module:docbox` command is the fastest way to generate documentation: ```bash # Minimal usage boxlang module:docbox --source=/path/to/code --mapping=myapp --output-dir=/docs # With title and excludes boxlang module:docbox --source=/src \ --mapping=myapp \ --output-dir=/docs \ --project-title="My API" \ --excludes="(tests|build)" # Use the frames (traditional three-panel) theme boxlang module:docbox --source=/src --mapping=myapp \ --output-dir=/docs \