summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2012-12-11 17:06:41 +0000
committerManolo Gouy <Manolo>2012-12-11 17:06:41 +0000
commit466cf80f6fa9eb0ab7feb0de2f63965d1b744df9 (patch)
tree0d4caaf583ff37ec4640e18f32d5ac2c589de1c6 /FL
parentd9666eb8c971affe9428524408b31e3501d4c76e (diff)
Properly Doxygen-comment fl_beep() and the associated enumeration.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9748 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
-rw-r--r--FL/fl_ask.H22
1 files changed, 14 insertions, 8 deletions
diff --git a/FL/fl_ask.H b/FL/fl_ask.H
index a1ccfdfa5..a3713e0c1 100644
--- a/FL/fl_ask.H
+++ b/FL/fl_ask.H
@@ -16,20 +16,26 @@
// http://www.fltk.org/str.php
//
+/** \file fl_ask.H
+ API for common dialogs.
+ */
+
#ifndef fl_ask_H
# define fl_ask_H
# include "Enumerations.H"
class Fl_Widget;
-/** Different system beeps available. \relatesalso fl_beep(int) */
-enum {
- FL_BEEP_DEFAULT = 0,
- FL_BEEP_MESSAGE,
- FL_BEEP_ERROR,
- FL_BEEP_QUESTION,
- FL_BEEP_PASSWORD,
- FL_BEEP_NOTIFICATION
+
+/** Different system beeps available.
+ \sa fl_beep(int) */
+enum Fl_Beep {
+ FL_BEEP_DEFAULT = 0, ///< Default beep.
+ FL_BEEP_MESSAGE, ///< Message beep.
+ FL_BEEP_ERROR, ///< Error beep.
+ FL_BEEP_QUESTION, ///< Question beep.
+ FL_BEEP_PASSWORD, ///< Password beep.
+ FL_BEEP_NOTIFICATION ///< Notification beep.
};
# ifdef __GNUC__