#4611 closed defect (fixed)
document the dojo API
Reported by: | dante | Owned by: | dante |
---|---|---|---|
Priority: | high | Milestone: | 1.0 |
Component: | General | Version: | 0.9 |
Keywords: | Cc: | ||
Blocked By: | Blocking: |
Description
generic ticket (because I can't find one that exists) to ref when making changes to trunk/dojo regarding documentation. 1.0 is right around the corner, so the time is now to bring all your parameters and summaries up to date. there are a lot of undocumented or poorly documented public APIs.
Attachments (1)
Change History (10)
comment:1 Changed 14 years ago by
comment:2 Changed 14 years ago by
(In [10692]) refs #4611 - a simple php doc-parser explorer that doesn't need drupal or databases. meant to be used to provide a 'live' example of what parser is reading from the source tree.
for example: _browse.php?ns=dojo&file=_base/html.js&ajaxy=1 and http://redesign.dojotoolkit.org/?q=jsdoc/dojo/HEAD/object/dojo._base.html/dojo.toggleClass&source
both show the same parameter parsing issue in dojo.toggleClass putting the first word of the param as the param type ( /* if */ ).
can be used to parse custom docs using the doc parser based on files in modules/
comment:3 Changed 14 years ago by
comment:4 Changed 14 years ago by
comment:5 Changed 14 years ago by
comment:6 Changed 13 years ago by
Resolution: | → fixed |
---|---|
Status: | new → closed |
there are a few of these floating around. documentation is a constant :)
(In [10691]) refs #4611 - small doc fixes to loader.js