[Gnash-commit] gnash ChangeLog server/character.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  07/01/26 10:10:50

Modified files:
        .              : ChangeLog 
        server         : character.h 

Log message:
                * server/character.h: more info about invalidated bounds
                  methods and members.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.2178&r2=1.2179
http://cvs.savannah.gnu.org/viewcvs/gnash/server/character.h?cvsroot=gnash&r1=1.39&r2=1.40

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.2178
retrieving revision 1.2179
diff -u -b -r1.2178 -r1.2179
--- ChangeLog   25 Jan 2007 21:25:37 -0000      1.2178
+++ ChangeLog   26 Jan 2007 10:10:50 -0000      1.2179
@@ -1,3 +1,8 @@
+2007-01-25 Sandro Santilli <address@hidden>
+
+       * server/character.h: more info about invalidated bounds
+         methods and members.
+
 2007-01-25 Martin Guy <address@hidden>
 
        * configure.ac: Regularize indentation, reorder things

Index: server/character.h
===================================================================
RCS file: /sources/gnash/gnash/server/character.h,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -b -r1.39 -r1.40
--- server/character.h  25 Jan 2007 13:37:46 -0000      1.39
+++ server/character.h  26 Jan 2007 10:10:50 -0000      1.40
@@ -18,7 +18,7 @@
 //
 //
 
-/* $Id: character.h,v 1.39 2007/01/25 13:37:46 strk Exp $ */
+/* $Id: character.h,v 1.40 2007/01/26 10:10:50 strk Exp $ */
 
 #ifndef GNASH_CHARACTER_H
 #define GNASH_CHARACTER_H
@@ -104,14 +104,12 @@
        bool m_invalidated;
 
 
-       /// Bounds of character instance before invalidating it
+       /// \brief
+       /// Bounds of this character instance before first invalidation
+       /// since last call to clear_invalidated().
        //
-       /// TODO: tell more about this, it is unclear what 
-       ///       does "before" invalidating means.
-       ///       In particular I've the impression that calling
-       ///       set_invalidated() updates this, which doesn't
-       ///       seem error-prone to me as multiple calls would
-       ///       make this member useless!
+       /// Will be set by set_invalidated() and used by
+       /// get_invalidated_bounds().
        ///
        /// NOTE: this is currently initialized as the NULL rectangle.
        ///
@@ -450,7 +448,10 @@
 
        /// @}
 
-       /// This function marks the character as being modified in aspect.
+       /// \brief
+       /// This function marks the character as being modified in aspect
+       /// and keeps track of current invalidated bounds the first time
+       /// it's called after each call to clear_invalidated().
        //
        /// Call this function *before* any change in this character
        /// that modifies its rendering. This information will be used
@@ -460,6 +461,9 @@
        /// rather then after as it will also take care of updating the
        /// previously invalidated bounds (m_old_invalidated_bounds)
        ///
+       /// Calling this function multiple time is a no-op, unless
+       /// clear_invalidated() is called in between.
+       ///
        /// NOTE: Marking a character as invalidated automatically marks
        ///       it's parent as being invalidated.
        ///
@@ -467,7 +471,7 @@
        ///
        void set_invalidated();
   
-       // Should be called by display()
+       /// Clear invalidated flag and reset m_old_invalidated_bounds to null.
        void clear_invalidated() {
                m_invalidated = false;    
                // Is it correct to set old bounds to null ?