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

Free observability with BxMCP: give your AI agents eyes inside a live BoxLang runtime

Free observability with BxMCP: give your AI agents eyes inside a live BoxLang runtime

Ortus Solutions today announces that bx-mcp, the Model Context Protocol (MCP) server for BoxLang, is now free for everyone. Install it, point any MCP capable client at it, and your AI coding assistant, IDE agent or automation pipeline can inspect and operate a live BoxLang runtime: JVM, caches, datasources, slow requests, schedulers, logs and more. No BoxLang+ subscription required.

Luis Majano
Luis Majano
October 29, 2026
Inherited a CFML Application With Few Tests? Here’s Where to Start!

Inherited a CFML Application With Few Tests? Here’s Where to Start!

You need to change an application that has been running for years.

It might be a ColdFusion customer portal, a Lucee application supporting internal operations, or a CFML system your team is preparing to modernize. People depend on it, but some of its behavior lives in old tickets, scattered documentation, and the memory of whoever has supported it longest.

Now a release is approaching. You know more testing would help. The difficult part is deciding where to begin without putting every other priority on hold.

Start with one important workflow and build evidence around what it needs to do.

Explore Ortus Quality Assurance Services

Maria Jose Herrera
Maria Jose Herrera
October 27, 2026