diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2022-11-11 16:43:33 +0100 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2022-11-11 16:43:33 +0100 |
| commit | a3a60ed27cd569a416dfbcf484d7324c86b5e224 (patch) | |
| tree | 27951b52bc2ea670a5eecb8657c136b309fafed3 /FL | |
| parent | 56cba05672faa953f3e078de6a2db2992dd888b9 (diff) | |
Improve and clarify documentation of fl_beep()
Diffstat (limited to 'FL')
| -rw-r--r-- | FL/fl_ask.H | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/FL/fl_ask.H b/FL/fl_ask.H index 44980132f..a315fb1f2 100644 --- a/FL/fl_ask.H +++ b/FL/fl_ask.H @@ -1,7 +1,7 @@ // // Standard dialog header file for the Fast Light Tool Kit (FLTK). // -// Copyright 1998-2021 by Bill Spitzak and others. +// Copyright 1998-2022 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this @@ -15,8 +15,8 @@ // /** \file fl_ask.H - API for common dialogs. - */ + API for common dialogs. +*/ #ifndef _FL_fl_ask_H_ #define _FL_fl_ask_H_ @@ -27,8 +27,13 @@ class Fl_Widget; -/** Different system beeps available. - \sa fl_beep(int) */ +/** Defines the different system beeps available. + + Some systems may play different sounds or use different sound volume + depending on the Fl_Beep value. The implementation is platform dependent. + + \sa fl_beep(int) +*/ enum Fl_Beep { FL_BEEP_DEFAULT = 0, ///< Default beep. FL_BEEP_MESSAGE, ///< Message beep. |