[Gnash-commit] gnash/server sprite_instance.h swf/PlaceObject2...

[Zou Lunkai]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Zou Lunkai <zoulunkai>  08/04/24 01:19:14

Modified files:
        server         : sprite_instance.h 
        server/swf     : PlaceObject2Tag.h 

Log message:
        docs update.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/server/sprite_instance.h?cvsroot=gnash&r1=1.182&r2=1.183
http://cvs.savannah.gnu.org/viewcvs/gnash/server/swf/PlaceObject2Tag.h?cvsroot=gnash&r1=1.22&r2=1.23

Patches:
Index: sprite_instance.h
===================================================================
RCS file: /sources/gnash/gnash/server/sprite_instance.h,v
retrieving revision 1.182
retrieving revision 1.183
diff -u -b -r1.182 -r1.183
--- sprite_instance.h   23 Apr 2008 07:24:10 -0000      1.182
+++ sprite_instance.h   24 Apr 2008 01:19:13 -0000      1.183
@@ -357,35 +357,9 @@
        /// Any successful new placement triggers invokation of the newly 
created
        /// instance's LOAD event.
        ///
-       ///
-       /// character_id
-       ///     The ID of the character to be added.
-       ///     It will be seeked in the CharacterDictionary
-       ///
-       /// name
-       ///     The name to give to the newly created instance.
-       ///     If NULL, the new instance will be assigned a sequential
-       ///     name in the form 'instanceN', where N is incremented
-       ///     at each call, starting from 1.
-       ///
-       /// event_handlers
-       ///
-       /// depth
-       ///     The depth to assign to the newly created instance.
-       ///
-       /// color_transform
-       ///     The color transform to apply to the newly created instance.
-       ///
-       /// matrix
-       ///     The matrix transform to apply to the newly created instance.
-       ///
-       /// ratio
-       ///
-       /// clip_depth
-       ///     If != character::noClipDepthValue, mark the created instance
-       ///     as a clipping layer. The shape of the placed character will be
-       ///     used as a mask for all higher depths up to this value.
-       ///     TODO: assert(clip_depth > depth) ?
+       /// @param tag
+       /// A swf defined placement tag(PlaceObject, or PlaceObject2, or 
PlaceObject3)
+       /// No ownership transfer, the tag is still owned by the 
movie_definition class.
        ///
        /// @return 
        ///     A pointer to the character being added or NULL

Index: swf/PlaceObject2Tag.h
===================================================================
RCS file: /sources/gnash/gnash/server/swf/PlaceObject2Tag.h,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -b -r1.22 -r1.23
--- swf/PlaceObject2Tag.h       23 Apr 2008 04:49:05 -0000      1.22
+++ swf/PlaceObject2Tag.h       24 Apr 2008 01:19:13 -0000      1.23
@@ -44,6 +44,8 @@
 
 /// SWF Tag PlaceObject (4) or PlaceObject2 (9) 
 //
+/// This tag is owned by the movie_definiton class
+///
 /// The PlaceObject tags can be used to:
 /// - Place a character to a depth. See isPlace().
 /// - Transform the character placed at a depth. See isMove().
@@ -53,6 +55,35 @@
 /// Postcondition of this tag execution is presence of an instance
 /// at the affected depth. See getDepth().
 ///
+///
+/// m_character_id:
+///    The ID of the character to be added.
+///    It will be seeked in the CharacterDictionary.
+///
+/// m_name:
+///    The name to give to the newly created instance if m_has_name is true.
+///    If m_has_name is false, the new instance will be assigned a sequential
+///    name in the form 'instanceN', where N is incremented
+///    at each call, starting from 1.
+///
+/// event_handlers
+///
+/// m_depth:
+///    The depth to assign to the newly created instance.
+///
+/// m_color_transform:
+///    The color transform to apply to the newly created instance.
+///
+/// m_matrix:
+///    The matrix transform to apply to the newly created instance.
+///
+/// m_ratio
+///
+/// m_clip_depth:
+///    If != character::noClipDepthValue, mark the created instance
+///    as a clipping layer. The shape of the placed character will be
+///    used as a mask for all higher depths up to this value.
+///
 class PlaceObject2Tag : public DisplayListTag
 {
 public: