Alfresco client-side JavaScript documentation

I may be late to the party on this one, but did you know that Will Abson has used JSDoc to generate documentation on Alfresco’s client-side JavaScript? It’s available for both Community and Enterprise releases on the Share Extras site on Google Code.

So if you’ve ever needed to quickly find out all of the methods available to you in Alfresco.util or Alfresco.component.Base, for example, put down that recursive grep and head over to Share Extras.

Will’s taken JSDoc and added some tweaks to make it more YUI aware. So if you’re following Alfresco’s pattern of comments in your own client-side JavaScript code, you can use the toolkit to generate doc specific to your project. Will explains how this works on his JSDoc wiki page.

This entry was posted in Alfresco. Bookmark the permalink.