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

boxlang-code-documenter

Generate DocBox-style documentation comments for BoxLang classes and functions.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

BoxLang code documentation is complex; this skill standardizes and automates the creation of Javadoc-style comments to improve IDE tooling, API references, and maintainability.

Core Features & Use Cases

  • Generates Javadoc-style documentation for classes, functions, and properties following DocBox conventions.
  • Documents arguments, returns, exceptions, and examples to produce structured, navigable API references for BoxLang codebases.
  • Helps maintain consistency across large projects by providing templates and best-practice patterns.

Quick Start

Place Javadoc-style comments directly above BoxLang class and function declarations to generate API reference documentation.

Frequently Asked Questions about boxlang-code-documenter

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

FAQPage Schema
How do I generate Javadoc-style documentation for BoxLang code?▼

You can generate Javadoc-style documentation for BoxLang by placing structured comments directly above class and function declarations, conforming to DocBox conventions to produce navigable API references.

What is the best way to standardize API documentation across a large BoxLang codebase?▼

The best way to standardize API documentation across a BoxLang codebase is to automate the generation of DocBox-style comments, ensuring consistent documentation for arguments, returns, and exceptions.

Does BoxLang support automated generation of DocBox-style API references?▼

Yes, BoxLang supports automated generation of DocBox-style API references by applying standardized documentation comments to classes, functions, and BIFs to improve IDE tooling and maintainability.

How do I document BoxLang BIFs and components for better IDE tooling?▼

To document BoxLang BIFs and components for better IDE tooling, generate standardized Javadoc-style comments that detail arguments, returns, and examples following DocBox API reference rules.

Can I use DocBox conventions to document exceptions and examples in BoxLang functions?▼

Yes, you can use DocBox conventions to document exceptions and examples in BoxLang functions by applying structured Javadoc-style templates that produce comprehensive and navigable API references.

Related Skills

Explore More Software Engineering Skills→
jrodrigopucajrodrigopuca

using-jsdoc

Document JavaScript and TypeScript code with JSDoc comments.

Community
Intermediate
ortus-docsortus-docs
16

boxlang-docbox

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

Official
Advanced
0xRayAI0xRayAI

lint

Run node-based linting servers to enforce code quality standards.

Official
Intermediate
ortus-docsortus-docs
16

boxlang-code-documenter

Generate Javadoc-style comments for BoxLang classes and functions.

Official
Basic