skills.rest
ortus-docs
ortus-docsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

boxlang-docbox

Generate browsable API documentation from BoxLang and CFML source code using DocBox.

16|78|Updated Nov 28, 2014
Search Tags:#documentation#cli#cfml#api-docs#boxlang#docbox#code-comment-docs
One-click install
npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-docbox
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: boxlang-docbox
Source: https://github.com/ortus-docs/coldbox-docs/tree/main/.agents/skills/boxlang-docbox
Command: npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-docbox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate browsable API documentation from BoxLang or CFML source code using DocBox.

Core Features & Use Cases

  • Automatically parses BoxLang/CFML source code and reads JavaDoc-style comments to produce API documentation in multiple formats.
  • Supports CLI and programmatic usage with installation, configuration, and multiple output strategies (HTML, JSON, UML/XMI, CommandBox).
  • Ideal for onboarding, API maintenance, and CI pipelines by keeping project docs in sync with code.

Quick Start

Run DocBox against your BoxLang or CFML project to generate browsable docs in your preferred formats.

Frequently Asked Questions about boxlang-docbox

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from BoxLang or CFML source code?▼

To generate API documentation, run DocBox against your BoxLang or CFML project. The tool parses your source code and JavaDoc-style comments to automatically produce browsable docs in your preferred formats.

What output formats are supported when generating BoxLang API docs?▼

BoxLang API documentation can be generated in multiple output formats, including HTML, JSON, UML/XMI, and CommandBox outputs. You can configure these output strategies programmatically or via the CLI.

Can I use DocBox to generate CFML API docs for large projects?▼

Yes, DocBox applies to BoxLang and CFML projects of varying sizes. It supports configuration options like multiple themes and excludes patterns to manage large codebases effectively.

Does DocBox parse JavaDoc-style comments in CFML and BoxLang code?▼

Yes, DocBox integrates with source code parsing to read JavaDoc-style comments in CFML and BoxLang projects. It uses these comments to build the generated browsable API documentation.

What is the best way to keep BoxLang API documentation in sync with code during CI?▼

The best way to keep docs in sync is integrating DocBox into your CI pipelines. Running DocBox programmatically ensures your API documentation is automatically regenerated from your BoxLang source code on every build.

How do I configure DocBox to exclude specific files or directories from API docs?▼

You can configure DocBox to exclude specific files or directories using exclude patterns. These patterns are supported during programmatic configuration and CLI usage to customize your generated API documentation output.

Related Skills

Explore More Content & Communication Skills→
ColdBoxColdBox

coldbox-docbox-annotations

Generate DocBox JavaDoc-style comments for BoxLang and CFML code.

Official
Basic
ortus-boxlangortus-boxlang

bx-docbox

Generate HTML, JSON, and UML/XMI API documentation from BoxLang source code.

Official
Intermediate
ortus-boxlangortus-boxlang

commandbox-testing

Run TestBox tests from the CommandBox CLI with configurable reporters.

Official
Intermediate
ColdBoxColdBox

coldbox-docbox-generation

Generate API documentation from BoxLang and CFML source code.

Official
Intermediate