[Gnash-commit] gnash ChangeLog backend/render_handler.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/10/13 08:58:27

Modified files:
        .              : ChangeLog 
        backend        : render_handler.h 

Log message:
        added links new pages, cleaned up doxygen pages.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.1182&r2=1.1183
http://cvs.savannah.gnu.org/viewcvs/gnash/backend/render_handler.h?cvsroot=gnash&r1=1.8&r2=1.9

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.1182
retrieving revision 1.1183
diff -u -b -r1.1182 -r1.1183
--- ChangeLog   13 Oct 2006 08:45:22 -0000      1.1182
+++ ChangeLog   13 Oct 2006 08:58:27 -0000      1.1183
@@ -1,5 +1,7 @@
 2006-10-13 Sandro Santilli <address@hidden>
 
+       * backend/render_handler.h: added links new pages, cleaned up
+         doxygen pages.
        * doc/Doxyfile.in: exclude mozilla-sdk and win32 paths from
          doxygen parsing
 

Index: backend/render_handler.h
===================================================================
RCS file: /sources/gnash/gnash/backend/render_handler.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- backend/render_handler.h    13 Oct 2006 08:06:58 -0000      1.8
+++ backend/render_handler.h    13 Oct 2006 08:58:27 -0000      1.9
@@ -35,7 +35,7 @@
 // 
 //
 
-/* $Id: render_handler.h,v 1.8 2006/10/13 08:06:58 udog Exp $ */
+/* $Id: render_handler.h,v 1.9 2006/10/13 08:58:27 strk Exp $ */
 
 #ifndef RENDER_HANDLER_H
 #define RENDER_HANDLER_H
@@ -94,6 +94,7 @@
 ///    fillstyle0=0 and fillstyle1=1. The inner rectangle will have 
 ///    fillstyle0=1 and fillstyle1=0.
 ///
+/// \code
 ///      +--------------------------------+
 ///      |XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX|
 ///      |XXX+------------------------+XXX|
@@ -101,15 +102,18 @@
 ///      |XXX+------------------------+XXX|
 ///      |XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX|
 ///      +--------------------------------+
+/// \endcode
 ///
 ///  - A rectangle is divided vertically in two halves, both having different
 ///    colors:
 ///
+/// \code
 ///      +-------A-------+-------B--------+
-///      |///////////////|################|
-///      A///////////////C################B
-///      |///////////////|################|
+///      |...............|################|
+///      A...............C################B
+///      |...............|################|
 ///      +-------A-------+-------B--------+
+/// \endcode
 ///
 ///    Flash will probably produce three paths (A,B,C) and two fill styles.
 ///    Paths "A" and "B" will have just one fill style (fillstyle1 will be 
@@ -214,9 +218,15 @@
 };
 
 
+/// Base class for render handlers.
+//
 /// You must define a subclass of render_handler, and pass an
-/// instance to set_render_handler().
-class DSOEXPORT render_handler
+/// instance to set_render_handler() *before* any SWF parsing begins.
+///
+/// For more info see page \ref render_handler_intro.
+/// 
+///
+class DOEXPORT render_handler
 {
 public:
        virtual ~render_handler() {}
@@ -249,8 +259,13 @@
        /// Delete the given bitmap info class.
        virtual void    delete_bitmap_info(bitmap_info* bi) = 0;
   
-  /// Sets the update region (called prior to begin_display). It is not 
-  /// required for all renderers. Parameters are world coordinates.
+       /// Sets the update region (called prior to begin_display).
+       //
+       /// It is not required for all renderers.
+       /// Parameters are world coordinates.
+       ///
+       /// For more info see page \ref region_update.
+       ///
   virtual void set_invalidated_region(const rect bounds) {    
     // implementation is optional    
   }