summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2018-06-23 20:50:22 +0000
committerMatthias Melcher <fltk@matthiasm.com>2018-06-23 20:50:22 +0000
commitb8e97d7c28ad6f168e9314dab3c7651365b1c71c (patch)
treeaa722d1eb241aef345b6009fac807f060f82f7c6 /FL
parentb1598dc70362f331da7a65f1e5ddece7c88299f3 (diff)
Doxygen only: fixed all block comments starting with an asterisk to space-only, fixed doxygen keywords prepended with @ to use a backward slash instead. No code was changed.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12970 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
-rw-r--r--FL/Fl_Copy_Surface.H22
-rw-r--r--FL/Fl_Gl_Window_Driver.H10
-rw-r--r--FL/Fl_Graphics_Driver.H10
-rw-r--r--FL/Fl_Image_Surface.H10
-rw-r--r--FL/Fl_Native_File_Chooser.H10
-rw-r--r--FL/Fl_Paged_Device.H2
-rw-r--r--FL/Fl_PostScript.H12
-rw-r--r--FL/Fl_Printer.H3
-rw-r--r--FL/Fl_Screen_Driver.H20
-rw-r--r--FL/Fl_System_Driver.H10
-rw-r--r--FL/Fl_Window_Driver.H26
-rw-r--r--FL/android.H10
-rw-r--r--FL/filename.H1
-rw-r--r--FL/gl.h31
-rw-r--r--FL/mac.H4
15 files changed, 91 insertions, 90 deletions
diff --git a/FL/Fl_Copy_Surface.H b/FL/Fl_Copy_Surface.H
index fbf710c4d..afbe2e290 100644
--- a/FL/Fl_Copy_Surface.H
+++ b/FL/Fl_Copy_Surface.H
@@ -67,18 +67,18 @@ public:
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/**
- * A base class describing the interface between FLTK and draw-to-clipboard operations.
- *
- * This class is only for internal use by the FLTK library.
- *
- * A supported platform should implement the virtual methods of this class
- * in order to support drawing to the clipboard through class Fl_Copy_Surface.
+ A base class describing the interface between FLTK and draw-to-clipboard operations.
+
+ This class is only for internal use by the FLTK library.
+
+ A supported platform should implement the virtual methods of this class
+ in order to support drawing to the clipboard through class Fl_Copy_Surface.
*/
class Fl_Copy_Surface_Driver : public Fl_Widget_Surface {
friend class Fl_Copy_Surface;
@@ -100,8 +100,8 @@ protected:
};
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
#endif // Fl_Copy_Surface_H
diff --git a/FL/Fl_Gl_Window_Driver.H b/FL/Fl_Gl_Window_Driver.H
index 4f4d9289c..88d2c14dc 100644
--- a/FL/Fl_Gl_Window_Driver.H
+++ b/FL/Fl_Gl_Window_Driver.H
@@ -18,9 +18,9 @@
//
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
#ifndef Fl_Gl_Window_Driver_H
@@ -205,8 +205,8 @@ class Fl_X11_Gl_Window_Driver : public Fl_Gl_Window_Driver {
#endif /* Fl_Gl_Window_Driver_H */
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
//
diff --git a/FL/Fl_Graphics_Driver.H b/FL/Fl_Graphics_Driver.H
index f80934bce..0255ae24f 100644
--- a/FL/Fl_Graphics_Driver.H
+++ b/FL/Fl_Graphics_Driver.H
@@ -18,9 +18,9 @@
//
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/** \file Fl_Graphics_Driver.H
@@ -558,8 +558,8 @@ protected:
#endif // FL_GRAPHICS_DRIVER_H
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
//
diff --git a/FL/Fl_Image_Surface.H b/FL/Fl_Image_Surface.H
index 69093ecf1..4f5a3de8c 100644
--- a/FL/Fl_Image_Surface.H
+++ b/FL/Fl_Image_Surface.H
@@ -91,9 +91,9 @@ public:
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/** A base class describing the interface between FLTK and draw-to-image operations.
@@ -123,8 +123,8 @@ protected:
};
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
#endif // Fl_Image_Surface_H
diff --git a/FL/Fl_Native_File_Chooser.H b/FL/Fl_Native_File_Chooser.H
index 22b5dd354..32016dc86 100644
--- a/FL/Fl_Native_File_Chooser.H
+++ b/FL/Fl_Native_File_Chooser.H
@@ -168,9 +168,9 @@ public:
};
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/** Represents the interface between FLTK and a native file chooser.
@@ -265,8 +265,8 @@ public:
};
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
diff --git a/FL/Fl_Paged_Device.H b/FL/Fl_Paged_Device.H
index 6d86e5840..cf2c1390c 100644
--- a/FL/Fl_Paged_Device.H
+++ b/FL/Fl_Paged_Device.H
@@ -31,7 +31,7 @@
/**
\brief Represents page-structured drawing surfaces.
- *
+
This class has no public constructor: don't instantiate it; use Fl_Printer
or Fl_PostScript_File_Device instead.
*/
diff --git a/FL/Fl_PostScript.H b/FL/Fl_PostScript.H
index de90bd225..6190d3f13 100644
--- a/FL/Fl_PostScript.H
+++ b/FL/Fl_PostScript.H
@@ -33,14 +33,14 @@ extern "C" {
}
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/**
\brief PostScript graphical backend.
- *
+
PostScript text uses vectorial fonts when using the FLTK standard fonts
and the latin alphabet or a few other characters listed in the following table.
The latin alphabet means all unicode characters between U+0020 and U+017F, or, in other words,
@@ -232,8 +232,8 @@ public:
};
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
/**
diff --git a/FL/Fl_Printer.H b/FL/Fl_Printer.H
index c5e0cc131..825f765d9 100644
--- a/FL/Fl_Printer.H
+++ b/FL/Fl_Printer.H
@@ -26,8 +26,7 @@
#include <FL/Fl_Paged_Device.H>
/**
- * \brief OS-independent print support.
- *
+ \brief OS-independent print support.
Fl_Printer allows to use all drawing, color, text, image, and clip FLTK functions, and to have them operate
on printed page(s). There are two main, non exclusive, ways to use it.
<ul><li>Print any widget (standard, custom, Fl_Window, Fl_Gl_Window) as it appears
diff --git a/FL/Fl_Screen_Driver.H b/FL/Fl_Screen_Driver.H
index 3a75d2c0c..ab78a4745 100644
--- a/FL/Fl_Screen_Driver.H
+++ b/FL/Fl_Screen_Driver.H
@@ -17,9 +17,9 @@
//
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
#ifndef FL_SCREEN_DRIVER_H
@@ -47,11 +47,11 @@ class Fl_Group;
class Fl_Input;
/**
- * A base class describing the interface between FLTK and screen-related operations.
- *
- * This class is only for internal use by the FLTK library.
- *
- * Each supported platform implements several of the virtual methods of this class.
+ A base class describing the interface between FLTK and screen-related operations.
+
+ This class is only for internal use by the FLTK library.
+
+ Each supported platform implements several of the virtual methods of this class.
*/
class FL_EXPORT Fl_Screen_Driver {
@@ -194,8 +194,8 @@ public:
#endif // !FL_SCREEN_DRIVER_H
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
//
diff --git a/FL/Fl_System_Driver.H b/FL/Fl_System_Driver.H
index 9b5a04f7e..c3f8dc013 100644
--- a/FL/Fl_System_Driver.H
+++ b/FL/Fl_System_Driver.H
@@ -18,9 +18,9 @@
//
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/** \file Fl_System_Driver.H
@@ -239,8 +239,8 @@ public:
#endif // FL_SYSTEM_DRIVER_H
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
//
diff --git a/FL/Fl_Window_Driver.H b/FL/Fl_Window_Driver.H
index 5962a5180..a695d422e 100644
--- a/FL/Fl_Window_Driver.H
+++ b/FL/Fl_Window_Driver.H
@@ -18,9 +18,9 @@
//
/**
- * @cond DriverDev
- * @addtogroup DriverDeveloper
- * @{
+ \cond DriverDev
+ \addtogroup DriverDeveloper
+ \{
*/
/** \file Fl_Window_Driver.H
@@ -41,14 +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.
- *
- * 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.
+ \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
{
@@ -195,8 +195,8 @@ public:
#endif // FL_WINDOW_DRIVER_H
/**
- * @}
- * @endcond
+ \}
+ \endcond
*/
//
diff --git a/FL/android.H b/FL/android.H
index 573664984..eea3d616c 100644
--- a/FL/android.H
+++ b/FL/android.H
@@ -31,8 +31,8 @@ extern "C" {
#endif
/*
- * This is the function that application code must implement, representing
- * the main entry to the app.
+ This is the function that application code must implement, representing
+ the main entry to the app.
*/
extern int main(int argc, char **argv);
@@ -51,9 +51,9 @@ typedef void *Window; // used by fl_find(), fl_xid() and class Fl_X
extern void *fl_gc;
/**
- * These events are specific to the Android OS driver system. They can
- * be read by adding a callback via Fl::add_system_handler() and reading Fl::event()
- * Don't change the order of these enums! See Fl_Android_Application.H .
+ These events are specific to the Android OS driver system. They can
+ be read by adding a callback via Fl::add_system_handler() and reading Fl::event()
+ Don't change the order of these enums! See Fl_Android_Application.H .
*/
enum Fl_Android_Platform_Event
{
diff --git a/FL/filename.H b/FL/filename.H
index a82d1ec6a..9d41008a9 100644
--- a/FL/filename.H
+++ b/FL/filename.H
@@ -15,6 +15,7 @@
*
* http://www.fltk.org/str.php
*/
+
/** \file
File names and URI utility functions.
*/
diff --git a/FL/gl.h b/FL/gl.h
index c7c7eb41d..bd0e8b6e6 100644
--- a/FL/gl.h
+++ b/FL/gl.h
@@ -23,21 +23,22 @@
// http://www.fltk.org/str.php
//
-/** \file gl.h
- * This file defines wrapper functions for OpenGL in FLTK
- *
- * To use OpenGL from within an FLTK application you MUST use gl_visual()
- * to select the default visual before doing show() on any windows. Mesa
- * will crash if you try to use a visual not returned by glxChooseVisual.
- *
- * Historically, this did not always work well with Fl_Double_Window's!
- * It can try to draw into the front buffer.
- * Depending on the system this might either
- * crash or do nothing (when pixmaps are being used as back buffer
- * and GL is being done by hardware), work correctly (when GL is done
- * with software, such as Mesa), or draw into the front buffer and
- * be erased when the buffers are swapped (when double buffer hardware
- * is being used)
+/**
+ \file gl.h
+ This file defines wrapper functions for OpenGL in FLTK
+
+ To use OpenGL from within an FLTK application you MUST use gl_visual()
+ to select the default visual before doing show() on any windows. Mesa
+ will crash if you try to use a visual not returned by glxChooseVisual.
+
+ Historically, this did not always work well with Fl_Double_Window's!
+ It can try to draw into the front buffer.
+ Depending on the system this might either
+ crash or do nothing (when pixmaps are being used as back buffer
+ and GL is being done by hardware), work correctly (when GL is done
+ with software, such as Mesa), or draw into the front buffer and
+ be erased when the buffers are swapped (when double buffer hardware
+ is being used)
*/
#ifndef FL_gl_H
diff --git a/FL/mac.H b/FL/mac.H
index 888ab633b..863ab0913 100644
--- a/FL/mac.H
+++ b/FL/mac.H
@@ -111,10 +111,10 @@ extern CGContextRef fl_gc;
/** \defgroup group_macosx Mac OS X-specific symbols
Mac OS X-specific symbols declared in <FL/platform.H>
\sa \ref osissues_macos
- @{ */
+ \{ */
/**
- * Attaches a callback to the "About myprog" item of the system application menu.
+ Attaches a callback to the "About myprog" item of the system application menu.
For back-compatibility.
Equivalent to Fl_Sys_Menu_Bar::about(Fl_Callback *cb, void *user_data).
*/