diff options
| author | Manolo Gouy <Manolo> | 2012-12-11 17:06:41 +0000 |
|---|---|---|
| committer | Manolo Gouy <Manolo> | 2012-12-11 17:06:41 +0000 |
| commit | 466cf80f6fa9eb0ab7feb0de2f63965d1b744df9 (patch) | |
| tree | 0d4caaf583ff37ec4640e18f32d5ac2c589de1c6 | |
| parent | d9666eb8c971affe9428524408b31e3501d4c76e (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
| -rw-r--r-- | FL/fl_ask.H | 22 | ||||
| -rw-r--r-- | src/fl_ask.cxx | 6 |
2 files changed, 20 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__ diff --git a/src/fl_ask.cxx b/src/fl_ask.cxx index 3d23f74cd..e6d8ba194 100644 --- a/src/fl_ask.cxx +++ b/src/fl_ask.cxx @@ -16,6 +16,11 @@ // http://www.fltk.org/str.php // +/** + \file fl_ask.cxx + \brief Utility functions for common dialogs. + */ + // Implementation of fl_message, fl_ask, fl_choice, fl_input // The three-message fl_show_x functions are for forms compatibility // mostly. In most cases it is easier to get a multi-line message @@ -272,6 +277,7 @@ const char* fl_close= "Close"; ///< string pointer used in common dialogs, you // fltk functions: /** Emits a system beep message. + \param[in] type The beep type from the \ref Fl_Beep enumeration. \note \#include <FL/fl_ask.H> */ void fl_beep(int type) { |