Re: [Gnash-commit] gnash ChangeLog doc/C/internals.xml

[ann]

On Tue, 6 Mar 2007, Rob Savoye wrote:

> strk wrote:
> > On Tue, Mar 06, 2007 at 08:46:12AM +0100, ann wrote:
>
> > Ehm... can we avoid complete examples ?
>
>  Most people are too lazy to read the code for examples, so putting
> them in the manual seemed a good idea at the time. I guess maintaining
> them is a pain in the neck, but in this case, hopefully how objects get
> instantiated in the VM will stop changing. :-) I do think that if
> examples are in manuals, they should be real code, and kept up to date.

I think that it is worth having one class which can be considered a sort
of flagship.  This would contain the most current interface and the cleanest
code.

However, I can see the problems of putting this in to some documentation
which is far removed from the code, as it becomes easy for the two to get
out of sync.  Certainly the code which was in the manual was quite out of
date.

Perhaps a solution for the full example would be to have the documentation 
point to a particular class as an excellent example of an ActionScript class?
That would require that that one class be kept up-to-date.

- Ann