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

A Year in Review - BoxLang 2024 Recap!

A Year in Review - BoxLang 2024 Recap!

BoxLang has come a long way since its beta release, and we're thrilled to share the incredible progress made so far. From its initial launch to the upcoming stable version, BoxLang has been evolving with new features, tools, and a growing ecosystem, all aimed at empowering modern developers.In this recap, we’ll highlight the milestones and advancements that have shaped BoxLang’s journey to this point. Let’s take a look at what we’ve achieved and what’s coming next!

Maria Jose Herrera
Maria Jose Herrera
January 03, 2025
Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

At Ortus Solutions, we’ve always been at the forefront of innovation in the ColdFusion ecosystem. From pioneering modern ColdFusion practices to developing cutting-edge tools and frameworks, we’ve been passionate to help and sup[port the community into shaping the future of web development.That’s why we decided to build BoxLang, our new JVM programming language that not only builds on the strengths of ColdFusion but takes modern software development to the next level.

Maria Jose Herrera
Maria Jose Herrera
December 23, 2024