[Gnash-commit] gnash backend/render_handler.h gui/gui.h server...

[Sandro Santilli]

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

Modified files:
        backend        : render_handler.h 
        gui            : gui.h 
        server         : character.h 

Log message:
        More doxygen cleanups (cross references in updated region detection)

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/backend/render_handler.h?cvsroot=gnash&r1=1.25&r2=1.26
http://cvs.savannah.gnu.org/viewcvs/gnash/gui/gui.h?cvsroot=gnash&r1=1.40&r2=1.41
http://cvs.savannah.gnu.org/viewcvs/gnash/server/character.h?cvsroot=gnash&r1=1.32&r2=1.33

Patches:
Index: backend/render_handler.h
===================================================================
RCS file: /sources/gnash/gnash/backend/render_handler.h,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -b -r1.25 -r1.26
--- backend/render_handler.h    5 Dec 2006 14:26:09 -0000       1.25
+++ backend/render_handler.h    6 Dec 2006 11:10:05 -0000       1.26
@@ -17,7 +17,7 @@
 // 
 //
 
-/* $Id: render_handler.h,v 1.25 2006/12/05 14:26:09 tgc Exp $ */
+/* $Id: render_handler.h,v 1.26 2006/12/06 11:10:05 strk Exp $ */
 
 #ifndef RENDER_HANDLER_H
 #define RENDER_HANDLER_H
@@ -114,7 +114,7 @@
 ///
 /// (this applies to the whole Gnash playback architecture)
 ///
-/// After advancing the root movie (see Gui::advance_movie) it is checked
+/// After advancing the root movie (see gnash::Gui::advance_movie) it is 
checked
 /// which region of the stage has been changed visibly (by computing the 
 /// bounds around updated characters). This has two advantages:
 /// 
@@ -128,17 +128,19 @@
 /// detect these and completely avoids to call any rendering function.
 /// 
 /// Of course, the most critical part is detection of changes. There is a 
-/// method called set_invalidated() which gets called whenever a critical
-/// property of a instance gets updated, like when it changes position, for
-/// example. It's really important to always call set_invalidated() whenever 
+/// method gnash::character::set_invalidated() which gets called whenever a
+/// critical property of a instance gets updated, like when it changes
+/// position, for example.
+/// It's really important to always call set_invalidated() whenever 
 /// code is added that changes the character instance in a visible way.
 /// 
 /// Even if no renderer really uses this information it has effects when
 /// skipping unchanged frames. If necessary, this feature can be switched
 /// off easily in gui.cpp (maybe using a runtime option?).
 ///
-/// Note the updated region is only passed to the GUI, which is itself 
-/// responsible of informing the renderer. This is because it's pointless
+/// Note the updated region is only passed to the gnash::Gui, which is itself 
+/// responsible of informing the renderer (see 
gnash::Gui::set_invalidated_region).
+/// This is because it's pointless
 /// to have a renderer which updates only a small part of the stage when
 /// the GUI shows it all since the area aroung the region is undefined.
 /// However, there can be a GUI which supports update regions without needing

Index: gui/gui.h
===================================================================
RCS file: /sources/gnash/gnash/gui/gui.h,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -b -r1.40 -r1.41
--- gui/gui.h   6 Dec 2006 10:21:32 -0000       1.40
+++ gui/gui.h   6 Dec 2006 11:10:06 -0000       1.41
@@ -105,6 +105,7 @@
     virtual bool setupEvents() = 0;
     
     /// Gives the GUI a *hint* which region of the stage should be redrawn.
+    //
     /// There is *no* restriction what the GUI might do with these 
coordinates. 
     /// Normally the GUI forwards the information to the renderer so that
     /// it avoids rendering regions that did not change anyway. The GUI can
@@ -132,6 +133,7 @@
     } 
 
     /// Asks the GUI handler if the next frame should be redrawn completely. 
+    //
     /// For example, when the contents of the player window have been 
destroyed,
     /// then want_redraw() should return true so that set_invalidated_region() 
is
     /// called with the coordinates of the complete screen. 
@@ -144,9 +146,9 @@
     virtual void setCursor(gnash_cursor_type newcursor);
 
 
-    /// \brief
-    /// Render the current buffer. For OpenGL, this means that the buffer is
-    /// swapped.
+    /// Render the current buffer.
+    //
+    /// For OpenGL, this means that the buffer is swapped.
     virtual void renderBuffer() = 0;
 
     /// @return The value to which the movie width should be scaled.
@@ -192,6 +194,7 @@
     static bool advance_movie(Gui* gui);
 
     /// Resize the client area view and the window accordingly.
+    //
     /// @param width  The desired width in pixels.
     /// @param height The desired height in pixels.
     void resize_view(int width, int height);

Index: server/character.h
===================================================================
RCS file: /sources/gnash/gnash/server/character.h,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -b -r1.32 -r1.33
--- server/character.h  6 Dec 2006 10:21:32 -0000       1.32
+++ server/character.h  6 Dec 2006 11:10:06 -0000       1.33
@@ -18,7 +18,7 @@
 //
 //
 
-/* $Id: character.h,v 1.32 2006/12/06 10:21:32 strk Exp $ */
+/* $Id: character.h,v 1.33 2006/12/06 11:10:06 strk Exp $ */
 
 #ifndef GNASH_CHARACTER_H
 #define GNASH_CHARACTER_H
@@ -372,6 +372,14 @@
 
        /// @}
 
+       /// This function marks the character as being modified in aspect.
+       //
+       /// Call this function whenever a change in this character
+       /// modifies its rendering. This information will be used
+       /// to detect visual changes that need to be redrawn.
+       ///
+       /// @see \ref region_update
+       ///
        void set_invalidated()
        {