Author: manolo
Date: 2012-12-11 09:18:38 -0800 (Tue, 11 Dec 2012)
New Revision: 9749
Log:
Properly Doxygen-comment fltk3::beep() and the associated enumeration.
Modified:
branches/branch-3.0/include/fltk3/ask.h
branches/branch-3.0/src/fltk3/ask.cxx
Modified: branches/branch-3.0/include/fltk3/ask.h
===================================================================
--- branches/branch-3.0/include/fltk3/ask.h 2012-12-11 17:06:41 UTC (rev
9748)
+++ branches/branch-3.0/include/fltk3/ask.h 2012-12-11 17:18:38 UTC (rev
9749)
@@ -27,6 +27,11 @@
// FLTK 123 complete
+/** \file ask.H
+ API for common dialogs.
+ */
+
+
#ifndef fltk3_ask_H
#define fltk3_ask_H
@@ -44,14 +49,15 @@
class Widget;
- /** Different system beeps available. \relatesalso fltk3::beep(int) */
- enum {
- BEEP_DEFAULT = 0,
- BEEP_MESSAGE,
- BEEP_ERROR,
- BEEP_QUESTION,
- BEEP_PASSWORD,
- BEEP_NOTIFICATION
+ /** Different system beeps available.
+ \sa fltk3::beep(int) */
+ enum Beep {
+ BEEP_DEFAULT = 0, ///< Default beep.
+ BEEP_MESSAGE, ///< Message beep.
+ BEEP_ERROR, ///< Error beep.
+ BEEP_QUESTION, ///< Question beep.
+ BEEP_PASSWORD, ///< Password beep.
+ BEEP_NOTIFICATION ///< Notification beep.
};
FLTK3_EXPORT void beep(int type = BEEP_DEFAULT);
Modified: branches/branch-3.0/src/fltk3/ask.cxx
===================================================================
--- branches/branch-3.0/src/fltk3/ask.cxx 2012-12-11 17:06:41 UTC (rev
9748)
+++ branches/branch-3.0/src/fltk3/ask.cxx 2012-12-11 17:18:38 UTC (rev
9749)
@@ -25,6 +25,11 @@
// http://www.fltk.org/str.php
//
+/**
+ \file ask.cxx
+ \brief Utility functions for common dialogs.
+ */
+
// Implementation of fltk3::message, fltk3::ask, fltk3::choice, fltk3::input
#include <stdio.h>
@@ -283,7 +288,7 @@
This function will ring whatever bell is easiest available on your device.
- \param[in] type predefined type of sound. such as BEEP_MESSAGE, etc.
+ \param[in] type predefined type of sound. such as BEEP_MESSAGE, from the \ref
fltk3::Beep enumeration.
\note \#include <fltk3/ask.h>
*/
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
