From a9fd08ff5ab8bbf3838200ceace671a72627d212 Mon Sep 17 00:00:00 2001 From: Matthias Melcher Date: Sat, 23 Jun 2018 16:47:40 +0000 Subject: Doxygen: created Group to document drivers, disabled by default Uncomment `ENABLED_SECTIONS += DriverDev` in documentation/Doxyfile.in to enable driver documentation. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12968 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Window_Driver.H | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) (limited to 'FL/Fl_Window_Driver.H') diff --git a/FL/Fl_Window_Driver.H b/FL/Fl_Window_Driver.H index dac150186..056a4adab 100644 --- a/FL/Fl_Window_Driver.H +++ b/FL/Fl_Window_Driver.H @@ -17,6 +17,12 @@ // http://www.fltk.org/str.php // +/** + * @cond DriverDev + * @addtogroup DriverDeveloper + * @{ + */ + /** \file Fl_Window_Driver.H \brief declaration of class Fl_Window_Driver. */ @@ -35,9 +41,14 @@ class Fl_Image; class Fl_RGB_Image; /** - \brief A base class for platform specific window handling code. - This class is only for internal use by the FLTK library. - Each supported platform implements several of the virtual methods of this class. + * \brief A base class for platform specific window handling code. + * + * This class is only for internal use by the FLTK library. + * + * When porting FLTK to a new platform, many mothods in this class provide + * a minimal default implementation. Some methods must be overridden to make + * sure that the Graphics Driver will draw into the bitmap associated with + * this window. */ class FL_EXPORT Fl_Window_Driver { @@ -186,6 +197,11 @@ public: #endif // FL_WINDOW_DRIVER_H +/** + * @} + * @endcond + */ + // // End of "$Id$". // -- cgit v1.2.3