To bring in 2008, it is time for an update to the documentation for Away3D.

Other than a significant makeover, the documentation now :

  • has been updated to V1.9.2
  • provides a search function
  • documetation can be easily managed
  • links to the new wiki are included for each class
  • examples will be included with the classes to make life easier
  • anyone can add comments to the documentation

At present, there is still a lot of content to be added to the documentation but this is now a simple process and can be done when required - rather than having to get comments put in the code and get it all regenerated. So more information will be being added all the time - if you need to know something in particular, contact us on the mailing list.

In conjuntion with the new LIVEDOCS, Pete has done a great job and introduced an EXAMPLES page to allow anyone to post any useful Away3D snippets or complete solutions that others would benfit from. Note, these will be subject to approval by the team.

And if that wasn’t enough, there is now a site WIKI to provide yet another mechanism for use contribution. There is a link from each class in the Livedocs to a class specific wiki page. If the page doesn’t exist, create it and add to it. This again is to allow all of you to help others understand and use the API.

If you come across any issues with the livedocs, examples or wiki, let me know via the mailing list and I’ll get it seen to as soon as I can.

NOTE: Please bear in mind that these items may need tweaking and will certainly have more information added and should be considered to be in a Work-In-Progress state. More notices will be posted when things of significance happen.

Greg

from:http://away3d.com/away3d-livedocs-examples-and-wiki