[Gnash-commit] gnash ChangeLog gui/gui.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  06/10/09 14:08:46

Modified files:
        .              : ChangeLog 
        gui            : gui.h 

Log message:
        forced generation of brief description for doxygen.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.1090&r2=1.1091
http://cvs.savannah.gnu.org/viewcvs/gnash/gui/gui.h?cvsroot=gnash&r1=1.17&r2=1.18

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.1090
retrieving revision 1.1091
diff -u -b -r1.1090 -r1.1091
--- ChangeLog   9 Oct 2006 14:03:52 -0000       1.1090
+++ ChangeLog   9 Oct 2006 14:08:46 -0000       1.1091
@@ -1,5 +1,6 @@
 2006-10-09 Sandro Santilli <address@hidden>
 
+       * gui/gui.h: forced generation of brief description for doxygen.
        * backend/sound_handler_sdl.h: removed unused <ffmpeg/avformat.h>
          include.
        * configure.ac: add some package names for required ffmpeg libs.

Index: gui/gui.h
===================================================================
RCS file: /sources/gnash/gnash/gui/gui.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -b -r1.17 -r1.18
--- gui/gui.h   9 Oct 2006 13:47:44 -0000       1.17
+++ gui/gui.h   9 Oct 2006 14:08:46 -0000       1.18
@@ -63,7 +63,7 @@
     /// Default constructor. Initialises members to safe defaults.
     Gui();
 
-    /**
+    /** \brief
      * Expanded constructor for more control over member values.
      *
      * @param xid The X11 Window ID to attach to. If this is argument is zero,
@@ -80,7 +80,7 @@
 
     virtual ~Gui();
     
-    /**
+    /** \brief
      * Initialise the gui and the associated renderer.
      * 
      * @param argc The commandline argument count.
@@ -94,8 +94,9 @@
     /// Set the time in milliseconds after which the programme should exit.
     virtual void setTimeout(unsigned int timeout) = 0;
 
-    /**
+    /** \brief
      * Create and display our window.
+     *
      * @param title The window title.
      * @param width The window width in pixels.
      * @param height The window height in pixels.
@@ -111,6 +112,7 @@
     /// Register event handlers.
     virtual bool setupEvents() = 0;
 
+    /// \brief
     /// Render the current buffer. For OpenGL, this means that the buffer is
     /// swapped.
     virtual void renderBuffer() = 0;
@@ -140,16 +142,19 @@
     /// @}
  
     /// Mouse notification callback to be called when the mouse is moved.
+    //
     /// @param x The mouse coordinate X component in pixels.
     /// @param y The mouse coordinate Y component in pixels.
     static void notify_mouse_moved(int x, int y);
 
     /// Mouse notification callback to be called when the mouse is clicked.
+    //
     /// @param mouse_pressed Determines whether the mouse button is being
     ///                      pressed (true) or being released (false)
     /// @param mask A binary representation of the buttons currently pressed.
     static void notify_mouse_clicked(bool mouse_pressed, int mask);
 
+    /// \brief
     /// Advances the movie to the next frame. This is to take place after the
     /// interval specified in the call to setInterval().
     static bool advance_movie(Gui* gui);