logo       

Re: documenting widgets was: release 0.4.1 bug triage: msg#00459

web.dojo.devel

Subject: Re: documenting widgets was: release 0.4.1 bug triage

Sorry that the widget documentation instructions aren't written down in the wiki, but see the italics part of this email thread for instructions on documenting widget parameters and widget summary:

http://dojotoolkit.org/pipermail/dojo-contributors/2006-October/004578.html

(as I mentioned, it just says to follow the example in DomWidget.js)


(btw, I'm also noticing in some widgets that there are still properties being created on the widget's prototype (in other words, on the object used with dojo.extend) and not the widget itself--i.e. there's no initializer function being defined. I thought we fixed these already?)

The consensus is to declare widget parameters in the dojo.extend part. By "consensus" I mean that that's the pattern that Alex set and we are all following that pattern. Again, see the example from DomWidget.js above.

I guess we didn't discuss where to declare private properties (typically with and underscore in front of their name); declaring those in the initializer function has the advantage of dealing w/arrays correctly, and hiding them from the doc parser. But for anything that needs to be doc'd we are putting it in the dojo.extend part.


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise