Re: [jQuery] Quality control for plugins

Jörn, if everyone wrote as coherently as you babble, I think all threads would benefit. :) I agree that a low barrier to entry is beneficial. I remember writing my first lines of jQuery code (back in January). From download to tutorial to production-ready functionality, it was about 1hr... for so

Re: [jQuery] Quality control for plugins

Brian Cherne schrieb: > On 3/26/07, *Jörn Zaefferer* <[EMAIL PROTECTED] > > wrote: > > Unfortuanetely, Javadoc is a bit limited for documenting jQuery > plugins. > For example, most plugins offer "options", that is, they accept a > object > whose prope

Re: [jQuery] Quality control for plugins

On 3/26/07, Jörn Zaefferer <[EMAIL PROTECTED]> wrote: Unfortuanetely, Javadoc is a bit limited for documenting jQuery plugins. For example, most plugins offer "options", that is, they accept a object whose properties are used to override any set defaults. How do you document all these options vi

Re: [jQuery] Quality control for plugins

Brian Cherne schrieb: > The Java engineers at my company told me about Javadoc... I didn't > even think to look for JSDoc... but it's essentially the same. I > haven't needed to extract the Javadoc code into a MSWord document, but > I think such tools already exist. I'll ask around. The other da

Re: [jQuery] Quality control for plugins

(sorry Howard for hijacking your thread) Yes, the comments would be stripped from your compressed (packed/minified) code. However, there's nothing keeping you from copying/pasting a simplified comment block into the compressed code. So, for example, my minified plug-in would have the comment: /*

Re: [jQuery] Quality control for plugins

Cool! Thanks for clarifying that for me. :o) Chris Kenneth wrote: > Oh no, you're actually correct then. I thought you were asking if you > could compress the code with the documentation included, not the other > way around... > > Yeah, since the compressed code is only meant to be used and no

Re: [jQuery] Quality control for plugins

Oh no, you're actually correct then. I thought you were asking if you could compress the code with the documentation included, not the other way around... Yeah, since the compressed code is only meant to be used and not modified or read, the documentation would be stripped, and therefore running

Re: [jQuery] Quality control for plugins

Oh... that's exactly the reason I thought it *wouldn't* work. I don't really understand javadocs... this is the first I've heard of them... but it sounded like it took your comments and turned them into these docs. I thought that since compressed js usually has the comments stripped out, that i

Re: [jQuery] Quality control for plugins

I am fairly new to structured documentation like javadoc, and for those of us without professional IDE's, is there an easy way to generate these doc blocks other than copy/paste from a template? I looked for something online but couldn't find anythingit seems like surely there'd be an online v

Re: [jQuery] Quality control for plugins

It should as long as the compressor removes comments. On 3/26/07, Christopher Jordan <[EMAIL PROTECTED]> wrote: That wouldn't work for compressed JS would it? Chris Brian Cherne wrote: > The Java engineers at my company told me about Javadoc... I didn't even > think to look for JSDoc... but i

Re: [jQuery] Quality control for plugins

That wouldn't work for compressed JS would it? Chris Brian Cherne wrote: > The Java engineers at my company told me about Javadoc... I didn't even > think to look for JSDoc... but it's essentially the same. I haven't > needed to extract the Javadoc code into a MSWord document, but I think > su

Re: [jQuery] Quality control for plugins

The Java engineers at my company told me about Javadoc... I didn't even think to look for JSDoc... but it's essentially the same. I haven't needed to extract the Javadoc code into a MSWord document, but I think such tools already exist. I'll ask around. The other day when I gave Aptana a trial-run

Re: [jQuery] Quality control for plugins

I'd like to see a central jQuery Plugins bug database. I think this would help greatly in the development process. I've gotten lots of great feedback via email (and prefer this greatly) but a tool to track development would also be greatly appreciated. -js On 3/25/07, howard chen <[EMAIL PROTEC

Re: [jQuery] Quality control for plugins

>- javadoc commenting of plug-in external interface Using what tool? jsDoc? I've found that jsDoc works great for class-based structures, but not so well for stand-along functions or library interfaces like jquery plugins. There should be some standard javadoc-style syntax, but not necessarily e

Re: [jQuery] Quality control for plugins

d be nice in this "standard interface"? An include of a search from the jQuery archives of any discussions related to that plugin. - Original Message From: Matt2012 <[EMAIL PROTECTED]> To: discuss@jquery.com Sent: Monday, March 26, 2007 5:01:31 AM Subject: Re: [jQuery] Qu

Re: [jQuery] Quality control for plugins

/me ponders how http://jqueryplugins.com/ is doing.. :) jQueryplugins.com was announced on this list a month ago today, eerie timing for this message! http://www.nabble.com/jqueryplugins.com-t3297295.html I have no other knowledge than what is in that post, but it sounds very exciting, and if i

Re: [jQuery] Quality control for plugins

essage > From: Matt2012 <[EMAIL PROTECTED]> > To: [EMAIL PROTECTED] > Sent: Monday, March 26, 2007 5:01:31 AM > Subject: Re: [jQuery] Quality control for plugins > > I wonder if its worth having a standard interface for plugin support > pages. > > i.e. the jquery

Re: [jQuery] Quality control for plugins

1 AM Subject: Re: [jQuery] Quality control for plugins I wonder if its worth having a standard interface for plugin support pages. i.e. the jquery form plugin (http://www.malsup.com/jquery/form/) is a great example with getting started, api, code samples, faq and download areas whereas other gr

Re: [jQuery] Quality control for plugins

I wonder if its worth having a standard interface for plugin support pages. i.e. the jquery form plugin (http://www.malsup.com/jquery/form/) is a great example with getting started, api, code samples, faq and download areas whereas other great plugins have sometimes very confusing support pages .

[jQuery] Quality control for plugins

hello, we have a lot of plugins at: http://docs.jquery.com/Plugins, however, many of them didn't follow the plugin guidlines, e.g. 1. use of $ instead of jQuery 2. missing ; any plan to control them? e.g. removing direct links from the plugin page? howa _