[Gnash-commit] gnash/server Movie.h

[strk]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         
Changes by:     strk <address@hidden>   06/02/01 14:25:44

Modified files:
        server         : Movie.h 

Log message:
        Added doxygen page about movies

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/server/Movie.h.diff?tr1=1.3&tr2=1.4&r1=text&r2=text

Patches:
Index: gnash/server/Movie.h
diff -u gnash/server/Movie.h:1.3 gnash/server/Movie.h:1.4
--- gnash/server/Movie.h:1.3    Sun Jan 29 10:19:51 2006
+++ gnash/server/Movie.h        Wed Feb  1 14:25:44 2006
@@ -17,6 +17,24 @@
 
 // Implementation for Movie object
 
+/// \page movie SWF Movies
+///
+/// SWF Movies definitions are created by reading an SWF stream.
+/// Gnash doesn't play SWF Movie definitions, but instances.
+/// So you can play the same SWF file (Movie definiton) using
+/// multiple instances.
+///
+/// A Movie definition is defined by the gnash::movie_definition class.
+/// A Movie instance is defined by the gnash::movie_interface class.
+/// 
+/// A Movie instance exposes the ActionScript
+/// Object base interface (gnash::as_object_interface),
+/// thus it can manage gnash::as_value members.
+///
+/// The implementation of SWF parsing for a Movie definition
+/// is found in gnash::movie_def_impl::read.
+///
+
 #ifndef GNASH_MOVIE_H
 #define GNASH_MOVIE_H
 
@@ -65,7 +83,7 @@
        //
        /// It cannot be played directly, and does not hold
        /// current state; for that you need to call create_instance()
-       /// to get a movie_instance.
+       /// to get a movie_instance (movie_interface).
        ///
        struct movie_def_impl : public movie_definition_sub
        {
@@ -289,7 +307,11 @@
 
                virtual const array<execute_tag*>*get_init_actions(int 
frame_number) { return &m_init_action_list[frame_number]; }
 
-               /// Read a .SWF movie.
+               /// Read Movie definition from an SWF file.
+               //
+               /// This function uses the gnash::s_tag_loaders
+               /// global variable to interpret specific tag types.
+               ///
                void read(tu_file *in);
 
                /// Fill up *fonts with fonts that we own.