Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#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)

editor.patch (8.3 KB) - added by dante 12 years ago.
random doc patch and jslint readiness

Download all attachments as: .zip

Change History (10)

comment:1 Changed 12 years ago by dante

(In [10691]) refs #4611 - small doc fixes to loader.js

comment:2 Changed 12 years ago by dante

(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 12 years ago by dante

(In [10771]) refs #4611 - cannot have (lowercased) reserved words as the first word in a summary or comment block, or the parser goes into a different tangent. minor cleanups and assit parser.

comment:4 Changed 12 years ago by dante

(In [10780]) refs #4611 - a few doc touchups to dijit - getting close to 1.0 we need to double check things are being parsed. if they are not it's either syntax problem or a parser bug, either way needs to be addressed.

Changed 12 years ago by dante

Attachment: editor.patch added

random doc patch and jslint readiness

comment:5 Changed 12 years ago by dante

(In [10972]) refs #4611 - documentation cleanups (and minor jslint-love) to RichText?.js

comment:6 Changed 12 years ago by dante

Resolution: fixed
Status: newclosed

there are a few of these floating around. documentation is a constant :)

comment:7 Changed 12 years ago by dante

(In [11659]) refs #4611 - doc updates

comment:8 Changed 12 years ago by dante

(In [11660]) refs #4611 - remove usage:, use example: (though not being picked up atm) and refs #4901 - one this.inherited() change

comment:9 Changed 12 years ago by bill

(In [13869]) Missing summary: keyword; refs #4611

Note: See TracTickets for help on using tickets.