Improved Documentation
Did you know that SproutCore has support for JSDoc-like documentation built right in? If you use JSDoc compatible comments in your code, you can just visit http://localhost:4020/YOURAPPURL/-docs and click “Rebuild”. In a few seconds you’ll have nice reference docs for your own code.
Of course, SproutCore is heavily commented in this way, though not everything has been converted over yet, it is pretty complete. I’ve just updated the docs viewer to make it play nice with the latest version of the framework. It’s also reskinned so it is more pleasant to look a.
Checkout the latest SproutCore reference docs.
Oh and one more thing: the SproutCode Doc browser comes with a built-in symbol search. Just type a method, property or class name you are interested in in the search field at the top and the source list to the left will filter. I don’t have a nice Mac-like “X” icon showing yet to clear the search field so for now just delete the text to remove the filter.
Just like the JSDoc tool itself, this nice doc viewer and symbol search are available for use in your app as well.
That is great help, but what about some basic getting started documentation? The sample controls demo mentions that one should look at the its source code. Where can the source code be found?
Hi Mike,
Getting started docs are a big hole right now. We’re working on it! In the mean time, you can check out the sample applications that come with the SproutCore source. View the source here (or click on “Checkout” to get a copy):
http://code.google.com/p/sproutcore/source/browse
The examples are in trunk/samples/clients
There is also an incomplete getting started tutorial here:
http://www.sproutcore.com/documentation/getting-started/
Charles,
Thanks for the link to the source code. I had found the “incomplete getting started tutorial”. It was just enough to get me interested, but not enough to go much further. The sample application code should do the trick though.