Opened 10 years ago
Closed 10 years ago
#13593 closed defect (invalid)
[patch] add comment to help jsdoc generation in on.js
Reported by: | zhangyp | Owned by: | Kris Zyp |
---|---|---|---|
Priority: | high | Milestone: | tbd |
Component: | Documentation | Version: | 1.7.0b1 |
Keywords: | Cc: | Chris Mitchell | |
Blocked By: | Blocking: |
Description
This patch add comment to help jsdoc generation in dojo/on.js
Attachments (1)
Change History (5)
Changed 10 years ago by
Attachment: | on.js.patch added |
---|
comment:1 Changed 10 years ago by
Owner: | set to Kris Zyp |
---|---|
Summary: | add comment to help jsdoc generation in on.js → [patch] add comment to help jsdoc generation in on.js |
comment:2 Changed 10 years ago by
preview.php will not generate document for js code that is not attached to dojo namespace. If preview.php understand the module local namespace, we do not need to attach that to dojo namespace.
comment:3 Changed 10 years ago by
This module does not map to dojo.XXX global functions, as it's brand new for 1.7 and is used with the Dojo 2.0 AMD call style. The doc parser does not handle modules like this well. I believe the current practice is that this module will be only doc'd via ref-guide in 1.x or until the api doc system can handle it.
Note: See
TracTickets for help on using
tickets.
I'm not sure if these changes make sense, as they imply that on.js creates functions in the dojo namespace, but it doesn't. Kris tends to document all of his API's in docs.dojocampus.org rather than through API doc.