summaryrefslogtreecommitdiff
path: root/src/fl_ask.cxx
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2010-12-01 17:38:29 +0000
committerManolo Gouy <Manolo>2010-12-01 17:38:29 +0000
commit180ec65687f7aafb4f4b1948a5543628d553802f (patch)
tree5b0e7f8ab7da0aca17c6a9be777229106d716a28 /src/fl_ask.cxx
parent04ca835e3aa366d218fe5ffc0cd2da78c0b614f0 (diff)
Doxygen changes to indicate what to #include for functions documented in modules.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7932 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_ask.cxx')
-rw-r--r--src/fl_ask.cxx11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/fl_ask.cxx b/src/fl_ask.cxx
index 962aebeb3..7e11fb944 100644
--- a/src/fl_ask.cxx
+++ b/src/fl_ask.cxx
@@ -261,6 +261,7 @@ const char* fl_close= "Close"; ///< string pointer used in common dialogs, you
/**
Emits a system beep message.
+ \note \#include <FL/fl_ask.H>
*/
void fl_beep(int type) {
#ifdef WIN32
@@ -330,6 +331,8 @@ void fl_beep(int type) {
\note Common dialog boxes are application modal. No more than one common dialog box
can be open at any time. Requests for additional dialog boxes are ignored.
+ \note \#include <FL/fl_ask.H>
+
\param[in] fmt can be used as an sprintf-like format and variables for the message text
*/
@@ -352,6 +355,7 @@ void fl_message(const char *fmt, ...) {
\note Common dialog boxes are application modal. No more than one common dialog box
can be open at any time. Requests for additional dialog boxes are ignored.
+ \note \#include <FL/fl_ask.H>
\param[in] fmt can be used as an sprintf-like format and variables for the message text
*/
@@ -374,6 +378,7 @@ void fl_alert(const char *fmt, ...) {
\note Common dialog boxes are application modal. No more than one common dialog box
can be open at any time. Requests for additional dialog boxes are ignored.
+ \note \#include <FL/fl_ask.H>
\param[in] fmt can be used as an sprintf-like format and variables for the message text
\retval 0 if the no button is selected or another dialog box is still open
@@ -398,7 +403,8 @@ int fl_ask(const char *fmt, ...) {
this dialog features up to 3 customizable choice buttons
\note Common dialog boxes are application modal. No more than one common dialog box
- can be open at any time. Requests for additional dialog boxes are ignored.
+ can be open at any time. Requests for additional dialog boxes are ignored.
+ \note \#include <FL/fl_ask.H>
\param[in] fmt can be used as an sprintf-like format and variables for the message text
\param[in] b0 text label of button 0
@@ -424,6 +430,7 @@ int fl_choice(const char*fmt,const char *b0,const char *b1,const char *b2,...){
/** Gets the Fl_Box icon container of the current default dialog used in
many common dialogs like fl_message(), fl_alert(),
fl_ask(), fl_choice(), fl_input(), fl_password()
+ \note \#include <FL/fl_ask.H>
*/
Fl_Widget *fl_message_icon() {makeform(); return icon;}
@@ -446,6 +453,7 @@ static const char* input_innards(const char* fmt, va_list ap,
\note Common dialog boxes are application modal. No more than one common dialog box
can be open at any time. Requests for additional dialog boxes are ignored.
+ \note \#include <FL/fl_ask.H>
\param[in] fmt can be used as an sprintf-like format and variables for the message text
\param[in] defstr defines the default returned string if no text is entered
@@ -471,6 +479,7 @@ const char* fl_input(const char *fmt, const char *defstr, ...) {
\note Common dialog boxes are application modal. No more than one common dialog box
can be open at any time. Requests for additional dialog boxes are ignored.
+ \note \#include <FL/fl_ask.H>
\param[in] fmt can be used as an sprintf-like format and variables for the message text
\param[in] defstr defines the default returned string if no text is entered