[dojo-contributors] Thoughts on API documentation

Alex Russell alex at dojotoolkit.org
Sat May 31 14:55:26 EDT 2008


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On May 30, 2008, at 11:36 PM, Neil Roberts wrote:

> I'm not opposed to switching systems,

I am.

Our current system is (with the caveats James has outlined) better  
than anything else out there. It allows for comments, should (soon?)  
allow for in-place editing, it figures out the structure of your  
JavaScript *even when it's not explicitly documented*, it understands  
Dojo's idioms, lets us document in a compact inline syntax, has an  
API, and looks beautiful.

We need to get offline working, and I understand James' frustration  
about the default system having a large-ish toolchain (drupal, a  
database, etc.), but this seems tractable if we really want to solve it.

Regards

- --
Alex Russell
alex at sitepen.com	A99F 8785 F491 D5FD 04D7 ACD9 4158 FFDF 2894 6876
alex at dojotoolkit.org	BE03 E88D EABB 2116 CC49 8259 CF78 E242 59C3 9723

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (Darwin)

iD8DBQFIQZ8ez3jiQlnDlyMRApRSAJ9HdqcOyaiK5EExCc1b6+L2eur13ACeOQXH
oiwB0yxuV6mDvNCHCPtW5bk=
=Dpb5
-----END PGP SIGNATURE-----



More information about the dojo-contributors mailing list