Fixed doxygen warnings and added a new documentation module "Callback

function typedefs" so that they appear in an own documentation group.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7334 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 18 insertions, 0 deletions

diff --git a/FL/Fl.H b/FL/Fl.H
index 8b9a5883e..dfd2a48c9 100644
--- a/FL/Fl.H
+++ b/FL/Fl.H
@@ -52,6 +52,22 @@ class Fl_Window;
 class Fl_Image;
 struct Fl_Label;
 
+
+/** \defgroup  callback_functions Callback function typedefs
+    \brief Typedefs for callback or handler functions passed as function parameters.
+
+    FLTK uses callback functions as parameters for some function calls, e.g. to
+    set up global event handlers (Fl::add_handler()), to add a timeout handler
+    (Fl::add_timeout()), and many more.
+
+    The typedefs defined in this group describe the function parameters used to set
+    up or clear the callback functions and should also be referenced to define the
+    callback function to handle such events in the user's code.
+
+    \see Fl::add_handler(), Fl::add_timeout(), Fl::repeat_timeout(),
+	 Fl::remove_timeout() and others
+  @{ */
+
 /** signature of some label drawing functions passed as parameters */
 typedef void (Fl_Label_Draw_F)(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align);
 
@@ -88,6 +104,8 @@ typedef void (*Fl_Atclose_Handler)(Fl_Window *window, void *data);
 /** signature of args functions passed as parameters */
 typedef int (*Fl_Args_Handler)(int argc, char **argv, int &i);
 
+/** @} */ /* group callback_functions */
+
 /**
   The Fl is the FLTK global (static) containing
   state information and global methods for the current application.