the singularity of being and nothingness
Documenting ExtJS/Sencha Touch Code with JSDuck
This will be a short post, I promise 🙂
Recently, I posted my version of a time picker in Sencha Touch 2. As part of this, I wanted to *really* document the component. I decided to leverage JSDuck, the tool which is currently used by Sencha to provide API documentation for…well…everything that they do.
Beyond looking pretty flipping sweet, the awesome part about JSDuck documentation is that it’s in the vein of “self-documenting” code. That is, beyond a few configuration comments you might make here or there, nearly everything that JSDuck spits out in terms of documentation (or is that duck-umentation…ugh) comes directly from the code you write anyway. Pretty nifty.
Anyway, if you’re interested, check out the documentation for JSDuck, and enjoy the screenshots of my documented component below.
| Print article | This entry was posted by existdissolve on January 28, 2013 at 8:18 pm, and is filed under ExtJS, JavaScript, Sencha Touch. Follow any responses to this post through RSS 2.0. You can leave a response or trackback from your own site. |
No comments yet.
No trackbacks yet.
ExtJS Quickie: Custom Event Domain
about 11 years ago - 3 comments
With ExtJS 4.2 came the awesome concept of Event Domains. Basically, these allow you to let your Controllers know about ALOT more events within your applications. For example, in 4.1, you could use the control() method within your controller to listen to component-level events. However, with Event Domains, you can now listen to events in…
ExtJS 4: Custom Editor for Property Grid
about 12 years ago - 4 comments
Yesterday, I was helping someone figure out how to add a custom, complex editor for use in a ExtJS Property Grid. The Anatomy of a Property Grid For some context, a Property Grid is like an editable grid, but instead of editing rows of data, you use a grid like interface to edit the properties…
Virtual Directory-Driven ExtJS 4 Development – Part Second
about 12 years ago - 1 comment
In my last post, I outlined a method that can be used to develop compilable-ExtJS 4 applications, with minimal configuration, that leverage a common, global location for shared assets and libraries. This approach works fine if you are merely “compiling” the application (e.g., only the JS part). However, if you do the full “build” you’ll…
ExtJS 4: Applying Model Validations to Forms
about 12 years ago - 6 comments
One of my absolute favorite things about ExtJS’ data model is how simple it is to apply a Model instance to a form. If you’ve never done this before, consider the following data model: Ext.define(‘Validations.model.Person’, { Â Â extend: ‘Ext.data.Model’, Â Â fields: [ Â Â Â Â {name:”name”, type:’string’}, Â Â Â Â {name:”age”,…
ExtJS 4: Querying Records in a Data Store
about 12 years ago - 3 comments
As you come to use data stores regularly within ExtJS applications, you’ll quickly come to realize just how powerful they are. With very little code, you can create robust data repositories that can not only store complex data, but can (perhaps more importantly) drive components within your applications. At some point, however, you’ll need to…
ColdFusion Queries to ExtJS Data Models
about 13 years ago - 5 comments
I love data Models in ExtJS. They are extremely simple to use, but are amazingly powerful for driving robust JavaScript applications. In fact, I’ve gotten to the point where I use them in just about everything I do, and they are fast becoming an indispensible part of my JavaScript development approach. A big part of…
Sugar: A Bit of JavaScript Sweetness
about 13 years ago - 3 comments
Twitter never lets me down 🙂 Today, I stumbled upon Sugar,  a really nice–and small–JavaScript library. Unlike monster libraries such as jQuery and ExtJS (which are awesome in their own ways…), Sugar is narrowly focused. It’s niche is simply extending native JS objects with intuitive methods. So want to capitalize the first word in a…
Sencha Touch Theming: Custom UIs
about 13 years ago - 5 comments
During the course of developing your Sencha Touch app, you will inevitably get around to theming…after all, while the default styles are nice, they don’t exactly scream individuality. Fortunately, Sencha Touch makes theming ridiculously easy, and there are a lot of resources available to help with getting started with that. But let’s talk about a…
Sencha Touch EditableList
about 13 years ago - No comments
Yeah, I know, I’m not the first person to the “create an EditableList for Sencha Touch” party. In fact, if you Google “sencha touch editable list,” you’ll find a lot of really nice code that will let you pretty easily integrate basic delete/sort functionality into your Sencha Touch app. However, none of the offerings I…
Sencha Touch: JumpToNode and the NestedList
about 13 years ago - 14 comments
Sencha Touch’s NestedList is an excellent component for creating the compact “drill-down” effect that we’re all used to on our mobile devices. It’s super-flexible, too. Whether you have a canned set of items, or need to retrieve each “level” via AJAX, it’ll handle it. I’ve used NestedList quite a bit, and have been generally happy…
