mrdoob/three.js — pull request #3311 by cjshannon (2013-04-13 19:41:38+00:00)
Title: added methods and properties to documentation

These changes are the result of a program I wrote to add properties/types and methods/parameters to the documentation if they weren't already there. I uploaded it to my github page as a repo if you want to look at it.

I got most of the property types. For the methods, I couldn't get the parameter types or return types so I put "todo" for those. I ignored the renderers and some of the geometries because instantiating them was becoming too complicated. Some of the changes I made were just to make it easier to parse as xml and to insert stuff in the right place. The xml parser didn't like unclosed meta tags or ampersands. I put all the ampersands back after, but left the closed meta tags. It would be very easy to remove the closing slashes, but I didn't think it mattered.

I spent a lot of time looking this over and fixing things, but it's probably not perfect. I think it's a definite improvement though. I did all the deletions manually. I'm not totally sure about some of the deletions I made. You can see those in 'deleted.txt' of the 3js-docscript repo on my page. Thinking about it now, I probably should have left most of them in. I was prioritizing consistent policy over good content. On the other hand, maybe in the future we'll have a better way of linking to inherited properties.

I noticed some other opportunities for programmatic editing (constructors, deleting unnecessary "todo" placeholders, maybe links to parent classes, maybe the renderers) that I'm going to work on after taking a little break.