One of the biggest pieces of feedback we’ve got is the lack of API documentation for Sugar, which has made it tricky for people to navigate thru our API and know what methods are available. We are kicking off a project to fix this, where in the process we will be going thru our entire API, top to bottom, cleaning it up and deprecating items along the way in an effort to make it much easier to customize and build add-ons to SugarCRM. You’ll start seeing pieces of this effort coming in 6.4, with the refactoring of the database layer, and it will be expanding to much of the other core code going forward. As always, stay tuned to this blog for insight into this effort.
The first step of this process for us was giving everyone a way to visualize what our API currently looks like. We turned to the PHP Community for a tool for this purpose, and found the DocBlox project lead by Mike van Riel. He helped us get started with using DocBlox, and then we were able to quickly get it integrated into our CI and build processes to generate nice looking API documentation for all editions of Sugar. And we are publishing these for all our developer community to use; you can view them right in the same area as our other documentation.
Let us know if this helps everyone out, as well as any other feedback on our API definition project.