summaryrefslogtreecommitdiff
path: root/src/fl_ask.cxx
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-03 12:00:21 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-03 12:00:21 +0000
commit727b50652cc53e27e6113f1420206ceac0b89146 (patch)
treeba555e70f32e0dd758c67c863224a0f269d2705e /src/fl_ask.cxx
parentfabf5fc18167f73526c21842fa8e68da29647094 (diff)
Added systematically missing in out modifiers to all param doxygen statements. Added a TODO.osx file in the root describing what we have to do on the os x platform before we can pre-release 1.3
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6368 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_ask.cxx')
-rw-r--r--src/fl_ask.cxx19
1 files changed, 11 insertions, 8 deletions
diff --git a/src/fl_ask.cxx b/src/fl_ask.cxx
index 530370346..ef4b84cfa 100644
--- a/src/fl_ask.cxx
+++ b/src/fl_ask.cxx
@@ -289,7 +289,7 @@ void fl_beep(int type) {
#endif // WIN32
}
/** Shows an information message dialog box
- \param fmt can be used as an sprintf-like format and variables for the message text
+ \param[in] fmt can be used as an sprintf-like format and variables for the message text
*/
void fl_message(const char *fmt, ...) {
va_list ap;
@@ -304,7 +304,7 @@ void fl_message(const char *fmt, ...) {
}
/** Shows an alert message dialog box
- \param fmt can be used as an sprintf-like format and variables for the message text
+ \param[in] fmt can be used as an sprintf-like format and variables for the message text
*/
void fl_alert(const char *fmt, ...) {
va_list ap;
@@ -319,7 +319,7 @@ void fl_alert(const char *fmt, ...) {
}
/** Shows a dialog displaying the \a fmt message,
this dialog features 2 yes/no buttons
- \param fmt can be used as an sprintf-like format and variables for the message text
+ \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
\retval 1 if yes is selected
*/
@@ -337,7 +337,10 @@ int fl_ask(const char *fmt, ...) {
/** Shows a dialog displaying the \a fmt message,
this dialog features up to 3 customizable choice buttons
- \param fmt can be used as an sprintf-like format and variables for the message text
+ \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
+ \param[in] b1 text label of button 1
+ \param[in] b2 text label of button 2
\retval 0 if the first button with \a b0 text is selected
\retval 1 if the second button with \a b1 text is selected
\retval 2 if the third button with \a b2 text is selected
@@ -374,8 +377,8 @@ static const char* input_innards(const char* fmt, va_list ap,
}
/** Shows an input dialog displaying the \a fmt message
- \param fmt can be used as an sprintf-like format and variables for the message text
- \param defstr defines the default returned string if no text is entered
+ \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
\return the user string input
*/
const char* fl_input(const char *fmt, const char *defstr, ...) {
@@ -391,8 +394,8 @@ const char* fl_input(const char *fmt, const char *defstr, ...) {
/** Shows an input dialog displaying the \a fmt message,
like fl_input except the input text is not shown,
'*' characters are displayed instead
- \param fmt can be used as an sprintf-like format and variables for the message text
- \param defstr defines the default returned string if no text is entered
+ \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
\return the user string input
*/
const char *fl_password(const char *fmt, const char *defstr, ...) {