coldbox-documenter

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.