From 5fcfaa2fa1e2552077c9c059540f9c153664d2bc Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Sat, 4 Oct 2008 12:00:16 +0000 Subject: Doxygen documentation: more paranoid fixes and complements in common dialogs. Added new test cases in the ask demo now featuring fl_message() and fl_password() API, made fl_choice() more specific about its return value tests in caller (also added a third button). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6369 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- src/Fl_Color_Chooser.cxx | 4 ++-- src/fl_ask.cxx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/Fl_Color_Chooser.cxx b/src/Fl_Color_Chooser.cxx index 6bfa70cc4..9a49e5caf 100644 --- a/src/Fl_Color_Chooser.cxx +++ b/src/Fl_Color_Chooser.cxx @@ -531,7 +531,7 @@ extern const char* fl_cancel; /** \brief Pops up a window to let the user pick an arbitrary RGB color. \image html fl_color_chooser.jpg - \param[in,out] name title label for the window + \param[in] name title label for the window \param[in,out] r, g, b color components in the range 0.0 to 1.0. \retval 1 if user confirms the selection \retval 0 if user cancels the dialog @@ -574,7 +574,7 @@ int fl_color_chooser(const char* name, double& r, double& g, double& b) { /** \brief Pops up a window to let the user pick an arbitrary RGB color. \image html fl_color_chooser.jpg - \param[in,out] name title label for the window + \param[in] name title label for the window \param[in,out] r, g, b color components in the range 0 to 255. \retval 1 if user confirms the selection \retval 0 if user cancels the dialog diff --git a/src/fl_ask.cxx b/src/fl_ask.cxx index ef4b84cfa..f57462673 100644 --- a/src/fl_ask.cxx +++ b/src/fl_ask.cxx @@ -379,7 +379,7 @@ static const char* input_innards(const char* fmt, va_list ap, /** Shows an input dialog displaying the \a fmt message \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 + \return the user string input if OK was pushed, NULL if Cancel was pushed */ const char* fl_input(const char *fmt, const char *defstr, ...) { fl_beep(FL_BEEP_QUESTION); @@ -396,7 +396,7 @@ const char* fl_input(const char *fmt, const char *defstr, ...) { '*' characters are displayed instead \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 + \return the user string input if OK was pushed, NULL if Cancel was pushed */ const char *fl_password(const char *fmt, const char *defstr, ...) { fl_beep(FL_BEEP_PASSWORD); -- cgit v1.2.3