That's fantastic Pete, I'll do my best to pitch in!
On Nov 10, 4:24 pm, "Peter Kapelyan" <[EMAIL PROTECTED]> wrote: > Thank you for your suggestion! > > We are doing our best to add descriptions (even simple examples) to the > documentation. > > Since this is an Open Source project, and we encourage others to > participate, I have written a tool here to do just that (add simple > examples, answers to questions, or even full source code). > > When an example is added using this tool (and is approved), it shows up in > the Documentation for the Class/properties selected. > > To add an Example:http://away3d.com/examples.php?add=new > > To see the Examples:http://away3d.com/examples > > It is a sort of "one hand washes another" situation where you can share with > others, and even use it as a place to reference code snippets of your own! > > So although the descriptions and examples may not fully be in the > documentation, a tool has been made to facilitate that, and everyone is > encouraged to participate. > > I am always encouraging people to add examples and even if it an answer to a > question (like yours), it can be entered in that tool to help others and > yourself into the future. > > So in other words: we are trying - everyone can pitch in :) > > -Pete > > On Sun, Nov 9, 2008 at 6:17 PM, bakedbeing <[EMAIL PROTECTED]>wrote: > > > > > > > Hey guys, I noticed that a lot of the functions in Away3D seem to have > > just the automatic compiler generated documentation, and not a lot of > > plain english to really describe the purpose or usage of the > > functions. > > > I'm looking for a render complete event, and muddling through the docs > > I've come upon sessionUpdated, but there's not a lot here on what a > > sessionUpdated event amounts to. There're some ways there to kind of > > put a loose idea together (including an even description saying that > > sessionUpdated means the render session still needs to be updated?), > > but even as a coder who does a lot of work in AS I'm often left > > scratching my head by the Away3D documentation, and when I go to > > google to try to find code examples or more comprehensive > > explanations, I often come up with nothing. For example, I've googled > > "addOnSessionUpdate" and I can't find a single bit of code or > > discussion online. > > > I really like the idea of Away3D and I want to push it at work > > (particularly because of it's support of multiple 3D formats), but > > sometimes it's a real struggle and feels like maybe the development > > has pushed forward on new features but without making sure people can > > follow along and use the libraries to the fullest. > > > Having used Blender almost daily lately and Papervision in the past, > > it seems that an active community and lots of tutes and documentation > > are what really keep a good OSS project alive and humming, but coming > > to Away3D I feel a little bit like I'm working in isolation. > > > Is there any project in the works to more fully document the API? > > Perhaps a push to get some content in the Wiki? > > -- > ___________________ > > Actionscript 3.0 Flash 3D Graphics Engine > > HTTP://AWAY3D.COM
