[Gnash-commit] gnash ChangeLog server/parser/movie_definition.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/12/05 09:56:57

Modified files:
        .              : ChangeLog 
        server/parser  : movie_definition.h 

Log message:
                * server/parser/movie_definition.h: Added more information
                  for the class (Doxygen class description).

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.1851&r2=1.1852
http://cvs.savannah.gnu.org/viewcvs/gnash/server/parser/movie_definition.h?cvsroot=gnash&r1=1.13&r2=1.14

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.1851
retrieving revision 1.1852
diff -u -b -r1.1851 -r1.1852
--- ChangeLog   4 Dec 2006 17:05:38 -0000       1.1851
+++ ChangeLog   5 Dec 2006 09:56:57 -0000       1.1852
@@ -1,3 +1,8 @@
+2006-12-05 Sandro Santilli <address@hidden>
+
+       * server/parser/movie_definition.h: Added more information
+         for the class (Doxygen class description).
+
 2006-12-04 Sandro Santilli <address@hidden>
 
        * server/parser/: movie_def_impl.h, movie_definition.h,

Index: server/parser/movie_definition.h
===================================================================
RCS file: /sources/gnash/gnash/server/parser/movie_definition.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- server/parser/movie_definition.h    4 Dec 2006 17:05:38 -0000       1.13
+++ server/parser/movie_definition.h    5 Dec 2006 09:56:57 -0000       1.14
@@ -66,9 +66,25 @@
 namespace gnash
 {
 
-/// Client program's interface to the definition of a movie
+/// Client program's interface to the definition of a movie or sprite
 //
-/// (i.e. the shared constant source info).
+/// This is the shared constant source info, the one that cannot
+/// be changed by ActionScript code.
+///
+/// The class derives from character_def to allow a movie
+/// to be put in the CharacterDictionary. This is probably
+/// unneeded for top-level movies, because they don't need
+/// to be put in any CharacterDictionary... anyway the
+/// current design requires both sprite_definition (a sprite)
+/// and movie_def_impl (a top-level movie) to derive from
+/// a common class to allow tag_loaders to take a pointer
+/// to the base class to act on (consider PLACEOBJECT tags...).
+///
+/// This design is uncomfortable when it comes to programmatically
+/// created characters, in that they do NOT have any *fixed* definition.
+/// A possible workaround to this would be not *requiring* character
+/// instances to have an associated character_def. I'll work on this
+/// --strk 2006-12-05.
 ///
 class movie_definition : public character_def
 {