coldbox-documenter

Generate DocBox-compatible documentation comments for ColdBox application code.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill coldbox-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coldbox-documenter
Source: https://github.com/ColdBox/skills/tree/main/coldbox/coldbox-documenter
Command: npx skills add https://github.com/ColdBox/skills --skill coldbox-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams eliminate inconsistent, outdated, or missing documentation in ColdBox applications by providing clear guidance and examples for writing accurate, maintainable comments that generate reliable DocBox API output.

Core Features & Use Cases

  • DocBox-compatible comment patterns: Provides standardized class and method comment templates that align with DocBox annotation expectations.
  • ColdBox-specific guidance: Explains how to document handler actions (including @event, @rc, @prc), interceptors, modules, configuration files, BoxLang and CFML idioms, and REST contracts.
  • Review checklist and examples: Offers a practical checklist and real-world examples for services, models, handlers, and Router/ColdBox config files to streamline code reviews and documentation generation.
  • Use Case: During a release, run the documentation checklist over handler and service changes to produce synchronized comments that DocBox will convert into accurate API docs.

Quick Start

Provide a ColdBox class or handler and ask to generate or improve documentation comments that follow DocBox conventions and include @event, @rc, @prc, parameter, return, and @throws details.

Frequently Asked Questions about coldbox-documenter

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

FAQPage Schema
How do I generate DocBox API documentation for ColdBox handlers?

Generate DocBox API documentation by writing standardized comment blocks for ColdBox handlers that define class summaries, method descriptions, @event, @rc, @prc usage, parameters, return types, and @throws details.

What format should I use for ColdBox documentation comments to ensure API docs generate correctly?

ColdBox documentation comments require standardized class and method templates aligned with DocBox annotations, ensuring concise summaries, parameter and return types, exception throws, and deprecation notes generate accurate API docs.

How do I document @event, @rc, and @prc usage in ColdBox handler actions?

Document @event, @rc, and @prc usage in ColdBox handler actions by adding specific annotations within method comment blocks to describe request collection variables, private request collection data, and event context interactions.

Can I use standard CFML and BoxLang conventions to document interceptors and modules?

CFML and BoxLang conventions apply to documenting interceptors, modules, views, and configuration files by aligning comment structures with framework idioms to produce consistent, DocBox-compatible API output.

What is the best way to prepare ColdBox code for API documentation generation during a release?

Prepare ColdBox code for API documentation generation by running a documentation checklist over handler, service, and model changes to synchronize comments that DocBox converts into accurate API docs.

Why are my DocBox API docs missing descriptions for ColdBox service methods?

DocBox API docs miss descriptions for ColdBox service methods when comments lack standardized templates, concise summaries, parameter and return types, or @throws annotations required for accurate generation.