Sounds good. Just wanted to make sure it was something on your radar, since from a business point of view this seems like another good niche that MoI would fit well into. Given how drop-dead simple it is to use compared to 98.4% of all of the other 3D apps out there, I think it would be something that a lot of 2D illustrators and graphics design folks would want to have in their bag of tricks. Provide a couple of 2D design oriented demo/training videos, and start advertising on graphic design blogs :-)
BTW, I'm still going gang-busters on the scripting documentation. I've worked out a scheme for annotating the Javascript API that keeps the documentation in a separate file from the .idl file. My script then merges the two together when creating the final documentation. It also handles changes to the .idl file (future-proofing it) so that stubs for any new API's get added to the annotation's file so that they can be documented later. The script also outputs statistics about how many documented/undocumented API's it processed so that it's easy to tell when new API's get added.
I've also set up a simple scheme in the annotation's file so that any annotation I make (which could obviously be wrong) gets displayed differently in the final output. This should make it easier for you to review the docs, since you can visually see any items that you haven't "approved" yet. Whenever you get a chance to update the annotation's file, you can simply remove the '?' character at the beginning of the annotation if it was correct. This will mark it as "approved" (of course you can also change the text that follows as well if it needs tweaking). There are also options to mark an annotation as "totally bogus" (in which case the description will be suppressed in the final output until someone has time to put a correct annotation in), or "private" (in which case, the entire API entry for that method, class, etc will be suppressed in the final output, in cases where a specific API is not intended to be used from Javascript, if indeed there are any).
I've already annotated a few classes to make sure everything is working. Now I'm going to start working on some UI extensions to make it easier for me to explore the inner workings of MoI a little better, to help further ensure that the annotations I'm making are as accurate as possible...
- Dave Morrill
|