[Phpmyadmin-devel] JSDoc-Toolkit and jQuery

[Michael Keck]

 Hi,

I think, jQuery must not be documented. But your own functions wich uses
jQuery.
You can use (like phpDocumentor too) link tags to the original jQuery
documentation.

jQuery uses it's own coding style, cause it's to large (thousand lines
of code, many
plugins). It's to much to change jQuery into a JSDoc format.

Regards
Michael

Am 12.08.2010 21:35, schrieb Ninad Pundalik:
> Hi,
>
> This is the last week for the Google Summer of Code, and we are
> supposed to be documenting our code changes.  The coding guidelines on
> the phpMyAdmin Wiki say that the comment syntax must be JSDoc
> compatible.
>
> As JSDoc is no longer maintained, I downloaded JSDoc-Toolkit, and
> tried running it on some of my jQuery and JavaScript code.  The
> toolkit could correctly parse all the functions written in JavaScript,
> but it could not document the jQuery procedural code.  I searched on
> the net, but could not see any examples of jQuery code being
> documented with this toolkit.  There are examples of jQuery plugins
> and functions being documented with JSDoc-Toolkit, but could not find
> anything for simple jQuery scripts.
>
> Has anyone seen JSDoc working with jQuery? (or for that matter, any
> other JavaScript library.  We could learn from how it was implemented
> for them.)  I discussed this issue with Ankit today, but even he was
> trying to figure out how to do this.  If there is no such example
> available, how do we proceed for this week, before we submit our code
> samples to Google?  The comments will be part of my code, whether the
> toolkit can parse them or not.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.phpmyadmin.net/pipermail/developers/attachments/20100813/4d90143a/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 583 bytes
Desc: OpenPGP digital signature
URL: <http://lists.phpmyadmin.net/pipermail/developers/attachments/20100813/4d90143a/attachment.sig>