Blog

Tip of the Week: ColdBox API Docs

Brad Wood October 17, 2012

Spread the word

Brad Wood

October 17, 2012

Spread the word


Share your thoughts

 

Hopefully you've seen and used the ColdBox docs, recipes, and video tutorials before.   What you may not know is there is an API reference that documents every class and method of the entire framework.  This can be very handy if you want to quickly look up all the arguments to the event.buildLink() method, or see what public methods can be called on a LogBox appender.  
 
The API docs are automatically generated based on component metadata (thanks to Mark Mandel's ColdDocs project) for every release of ColdBox that introduces API changes. The API Docs are nicely formatted much like Java Docs and even show what components are extended as well as inherited methods.  
 
You can download an HTML version of the API docs for any version of ColdBox, WireBox, CacheBox, LogBox, and MockBox here:
 
If you just want to search on the fly, check out our API Quick Docs which allow you to quickly search for any class or method.
 
Too lazy to leave your IDE to search the API docs?   Check out this wiki page that shows you how to install the syntax dictionaries into your favorite IDE to get intellisense as you type.
 

Add Your Comment

Recent Entries

BoxLang v1.13.0: Compatibility, Concurrency, and Formatter Maturity

BoxLang v1.13.0: Compatibility, Concurrency, and Formatter Maturity

BoxLang 1.13.0 is here, and it marks an important step forward for the platform. This release includes 48 tickets—every one of them completed—reflecting a focused effort on CFML compatibility, a more robust concurrency engine, a production-hardened miniserver, and meaningful tooling improvements.

Luis Majano
Luis Majano
April 30, 2026
🚀 ColdBox CLI 8.11: The Era of AI Skills Comes to Every ColdBox & BoxLang App

🚀 ColdBox CLI 8.11: The Era of AI Skills Comes to Every ColdBox & BoxLang App

ColdBox CLI 8.11 is here, and it's one of the most significant releases we've shipped for AI-assisted development. This release wires the CLI directly into our brand new public skills directory at skills.boxlang.io, brings our AI tooling in line with industry-wide agent conventions, and introduces a wave of quality-of-life improvements that make AI integration feel less like setup and more like infrastructure.

Luis Majano
Luis Majano
April 30, 2026