docs for mr. doob's three.js

[paulirish]

three.js is (and certainly will be) one of the most important libraries for interactive development.
https://github.com/mrdoob/three.js

but it does not have any documentation or tutorials, walkthroughs, etc.
it needs them badly.

maybe something like :

• http://processingjs.org/reference/articles/jsQuickStart
• http://processingjs.org/learning

and a rough API reference of course.

[danielschwartz]

I actually have a document where I have tried to break down the objects/API as much as possible. Ill get it cleaned up and thrown somewhere public.

[paulirish]

no way! that's excellent! looking fwd to it.

[danielschwartz]

Took a little bit but here is my extremely rudimentary api/info sheet for THREE.js, feel free to email me with changes, or if you would like to become an editor.

API/InfoSheet: http://goo.gl/TI3Js

[staunsholm]

ran jsdoc on the project, quite useful:

http://www.staunsholm.dk/THREE/jsdoc/

Mikkel Staunsholm

[mrdoob]

Oh my... I should have checked here first before writing this from scratch:

https://github.com/mrdoob/three.js/wiki/r33-API-Reference

:S

[staunsholm]

The jsdoc is now updated to r33:

http://staunsholm.dk/THREE/jsdoc/

a zip of the documentation is available here:

http://staunsholm.dk/THREE/THREE-jsdoc.zip

Mkkl.

[staunsholm]

(and now all constructors are marked with @constructor, producing much better docs. ie. inlined methods are now included :-)

[mrdoob]

Nice!

Is this what you're using?

http://jsdoc.sourceforge.net/

[staunsholm]

yep. like this:

perl jsdoc.pl ../mrdoob-three.js/src/ -r -d THREE-jsdoc

and adding this before each constructor:

/**

• @constructor
  */

Mkkl.

[staunsholm]

ups. that sould be:

/**
 * @constructor
 */

[mrdoob]

Yeah... I just think I'll try to avoid going that path (code will header comments for each method) makes it harder to read...

[paulirish]

aint that pretty: http://threejs.org/

nice work, Malte Buttjer !

also thx to aerotwist for this awesome guy: http://aerotwist.com/lab/getting-started-with-three-js/

[jwill]

Recently started a series on Google+ working though the Nehe Tutorials using CoffeeScript and Three.js: https://plus.google.com/s/threejsbyexample

[staunsholm]

finally got around to updating the generated jsdoc documentation (r53):

http://staunsholm.dk/three/jsdoc

I managed to make some changes to jsdoc, so no jsdoc tags needed in the code - of course, all this is still just nice-to-have when the official docs aren't done yet.

[paulirish]

awesome! thanks for that.

On Tue, Nov 20, 2012 at 4:39 PM, Mikkel Staunsholm <notifications@github.com

wrote:

finally got around to updating the generated jsdoc documentation (r53):

http://staunsholm.dk/three/jsdoc

I managed to make some changes to jsdoc, so no jsdoc tags needed in the
code - of course, all this is still just nice-to-have when the official
docs aren't done yet.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17#issuecomment-10581044.