skills.rest
ortus-boxlang
ortus-boxlangOFFICIAL
Explore all skills by this author →
Website𝕏@tryboxlangGitHub

boxlang-docbox

Generate API documentation from JavaDoc-style comments in BoxLang and CFML projects.

Updated Apr 10, 2026
Search Tags:#html#cfml#api-documentation#boxlang#commandbox#docbox#javadoc-comments
One-click install
npx skills add https://github.com/ortus-boxlang/skills --skill boxlang-docbox-ortus-boxlang
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: boxlang-docbox
Source: https://github.com/ortus-boxlang/skills/tree/main/boxlang-developer/docbox
Command: npx skills add https://github.com/ortus-boxlang/skills --skill boxlang-docbox-ortus-boxlang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

DocBox automates the generation of API documentation for BoxLang and CFML projects by extracting JavaDoc-style comments and aggregating metadata into browsable output formats.

Core Features & Use Cases

  • Install and configure BoxLang/CommandBox documentation workflows via CLI and programmatic usage.
  • Generate documentation across HTML, JSON, UML/XMI, and CommandBox formats, with customizable themes and mappings.
  • Use multi-source and excludes capabilities, and extend with custom strategies; maintain backward compatibility with existing DocBox APIs and CI/CD pipelines.

Quick Start

Install DocBox and generate API documentation for your BoxLang or CFML project using BoxLang Module commands or the programmatic API.

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 for a CFML or BoxLang project?▼

Generate API documentation for BoxLang and CFML by parsing JavaDoc-style comments and metadata into browsable HTML, JSON, or UML outputs. Use CommandBox CLI commands or the programmatic API to configure sources and produce docs.

What output formats are supported for BoxLang and CFML API documentation?▼

BoxLang and CFML API documentation supports HTML, JSON, UML/XMI, and CommandBox output formats. You can customize themes and mappings to fit different documentation workflows and downstream processing needs.

Can I integrate API documentation generation into a CI/CD pipeline for CFML projects?▼

Integrate DocBox into CI/CD pipelines using CommandBox CLI or its programmatic API to automate API documentation builds. Configure multi-source mappings and excludes to control scope across project modules.

Do I need to write JavaDoc-style comments for CFML API documentation to work?▼

JavaDoc-style comments are required for DocBox to extract metadata and generate comprehensive API documentation for BoxLang and CFML. Without these comments, the parser lacks the necessary context for browsable output.

How do I exclude specific files or directories when generating CFML API documentation?▼

Use the excludes capability in DocBox configuration to skip specific files or directories during API documentation generation. This works across both CLI and programmatic setups for BoxLang and CFML projects.

Can I extend the documentation strategy for custom CFML metadata parsing?▼

DocBox supports custom strategy extensions for parsing and rendering BoxLang and CFML metadata. Extend the strategy pattern to handle specialized JavaDoc-style tags or unique project documentation requirements.

Related Skills

Explore More Software Engineering Skills→
ortus-docsortus-docs
16

boxlang-docbox

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

Official
Advanced
ortus-boxlangortus-boxlang

bx-docbox

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

Official
Intermediate
ColdBoxColdBox

commandbox-boxlang

Configure BoxLang servers in CommandBox via server.json and engine setup.

Official
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate