coldbox-docbox-annotations

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of DocBox JavaDoc-style comments for BoxLang and CFML code.

Core Features & Use Cases

  • Ensures consistent author/version metadata in documentation blocks across BoxLang and CFML components.
  • Generates DocBox annotations for classes, properties, and functions to streamline API documentation generation.
  • Supports preparing source code for DocBox-driven API documentation pipelines.

Quick Start

Annotate a BoxLang class with DocBox documentation comments.

Frequently Asked Questions about coldbox-docbox-annotations

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

FAQPage Schema
How do I generate DocBox annotations for CFML components?

To generate DocBox annotations for CFML components, you can automate the creation of JavaDoc-style comments for classes, properties, and functions to standardize metadata like author, version, and return types.

What are DocBox annotations used for in BoxLang projects?

DocBox annotations in BoxLang projects are used to standardize author, version, since, return, and deprecation metadata in structured doc blocks, streamlining the generation of API documentation.

Can I use this to prepare CFML source code for an API documentation pipeline?

Yes, you can prepare CFML source code for an API documentation pipeline by generating structured DocBox documentation comments across classes, properties, and functions to ensure consistent metadata.

Does this approach work for both BoxLang and CFML codebases?

Yes, this approach works for both BoxLang and CFML codebases, applying standard JavaDoc-style comment conventions to document classes, properties, and functions across your projects.

What metadata can I standardize using DocBox comments for BoxLang?

Using DocBox comments for BoxLang, you can standardize author, version, since, return, and deprecation metadata within your documentation blocks across components and functions.