[Tip of the Week] ColdBox API Docs

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.



ColdBox Platform Evangelist
Ortus Solutions, Corp

E-mail: brad@coldbox.org
ColdBox Platform: http://www.coldbox.org
Blog: http://www.codersrevolution.com