[Gnash-commit] gnash/server sprite_instance.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/09/21 10:13:11

Modified files:
        server         : sprite_instance.h 

Log message:
        Added doxygen dox about timelines and variable scopes

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/server/sprite_instance.h?cvsroot=gnash&r1=1.24&r2=1.25

Patches:
Index: sprite_instance.h
===================================================================
RCS file: /sources/gnash/gnash/server/sprite_instance.h,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -b -r1.24 -r1.25
--- sprite_instance.h   20 Sep 2006 14:57:23 -0000      1.24
+++ sprite_instance.h   21 Sep 2006 10:13:11 -0000      1.25
@@ -62,6 +62,11 @@
 {
 
 /// Stateful Sprite object. Also known as a MovieClip.
+//
+/// Instance of this class are also known as "timelines".
+/// This means that they define a variable scope (see
+/// the as_environment member) and are divided into "frames"
+///
 class sprite_instance : public character
 {
 
@@ -506,6 +511,7 @@
        // a bit-array class would be ideal for this
        std::vector<bool>       m_init_actions_executed;
 
+       /// This timeline's variable scope
        as_environment  m_as_environment;
 
        // For built-in sprite ActionScript methods.