Didn't mean to hijack your thread either but as Jesse mentioned, it's kind of part and parcel to the API documentation. As I alluded to before, the conversation I've been having with Owen WRT what to call things started directly from a discussion of the API documentation (more or less).
Certainly we should talk about those methods as far as writing widgets go; but perhaps the best place for them is the book?
trt
On 10/27/06,
Bill Keese <bill@xxxxxxxxxxxxxxx> wrote:
Yeah, that's something to think about. The thing is that functions like
fillInTemplate() should be documented for people that want to write
their own widgets, but that documentation is distracting for someone
that just wants to use a widget, unless the doc is clear.
Which reminds me that the event handlers (onClick() etc.) are another
ball of wax, because users attach to them but never call them directly.
But hopefully those functions are easy to distinguish because they
start with "on".
Jesse Kuhnert wrote:
> Oh...If people are feeling like the code has finally caught up with
> documentation more or less you could just say that functions without doc
> parseable comments don't get displayed by default? Either that or have a
> special easy to use doc comment that marks a function as something to
> not auto doc.
>
> If they don't see the function at all in the online docs I'd say that
> would be the overall easiest way to start them off with not calling the
> wrong functions.
>
> On 10/27/06, * Bill Keese* <bill@xxxxxxxxxxxxxxx
> <mailto:bill@xxxxxxxxxxxxxxx>> wrote:
>
> Guys, seems like you missed my point. I wasn't trying to start yet
> another conversation about nomenclature or about have _javascript_ isn't
> java. I'm just talking about the API doc and how we notate which
> functions users are supposed to call, and which functions they aren't
> supposed to call.
> _______________________________________________
> dojo-contributors mailing list
>
dojo-contributors@xxxxxxxxxxxxxxx
> <mailto:dojo-contributors@xxxxxxxxxxxxxxx>
>
http://dojotoolkit.org/mailman/listinfo/dojo-contributors
>
>
>
>
> --
> Jesse Kuhnert
> Tapestry/Dojo/(and a dash of TestNG), team member/developer
>
> Open source based consulting work centered around
> dojo/tapestry/tacos/hivemind. http://blog.opencomponentry.com
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> dojo-contributors mailing list
> dojo-contributors@xxxxxxxxxxxxxxx
>
http://dojotoolkit.org/mailman/listinfo/dojo-contributors
_______________________________________________
dojo-contributors mailing list
dojo-contributors@xxxxxxxxxxxxxxx
http://dojotoolkit.org/mailman/listinfo/dojo-contributors
_______________________________________________
dojo-contributors mailing list
dojo-contributors@xxxxxxxxxxxxxxx
http://dojotoolkit.org/mailman/listinfo/dojo-contributors
