diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/fl_ask.cxx | 19 | ||||
| -rw-r--r-- | src/fl_file_dir.cxx | 8 | ||||
| -rw-r--r-- | src/fl_labeltype.cxx | 2 | ||||
| -rw-r--r-- | src/fl_utf.c | 6 |
4 files changed, 19 insertions, 16 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, ...) { diff --git a/src/fl_file_dir.cxx b/src/fl_file_dir.cxx index 0db2d3453..008fa33b5 100644 --- a/src/fl_file_dir.cxx +++ b/src/fl_file_dir.cxx @@ -64,10 +64,10 @@ void fl_file_chooser_ok_label(const char *l) { /** \relates Fl_File_Chooser Shows a file chooser dialog and get a filename. \image html Fl_File_Chooser.jpg - \param message text in title bar - \param pat filename pattern filter - \param fname initial/default filename selection - \param relative 0 for absolute path name, relative path name otherwise + \param[in] message text in title bar + \param[in] pat filename pattern filter + \param[in] fname initial/default filename selection + \param[in] relative 0 for absolute path name, relative path name otherwise \return the user selected filename, in absolute or relative format or NULL if user cancels */ diff --git a/src/fl_labeltype.cxx b/src/fl_labeltype.cxx index 6f7f00545..9eb24a8b5 100644 --- a/src/fl_labeltype.cxx +++ b/src/fl_labeltype.cxx @@ -89,7 +89,7 @@ void Fl_Label::draw(int X, int Y, int W, int H, Fl_Align align) const { } /** Measures the size of the label. - \param W, H in out : this is the requested size for the label text plus image; + \param[in,out] W, H : this is the requested size for the label text plus image; on return, this will contain the size needed to fit the label */ void Fl_Label::measure(int& W, int& H) const { diff --git a/src/fl_utf.c b/src/fl_utf.c index f42dfeaec..d78368550 100644 --- a/src/fl_utf.c +++ b/src/fl_utf.c @@ -34,8 +34,8 @@ extern "C" { /** Convert a Unicode character into a utf-8 sequnece. - \param uc[in] Unicode characte - \param text[out] utf-8 sequence will be written here; if this pointer is + \param[in] uc Unicode characte + \param[out] text utf-8 sequence will be written here; if this pointer is \c NULL, only the length of the utf-8 sequence is calculated \return length of the sequence in bytes */ @@ -50,7 +50,7 @@ extern "C" { /** Calculate the size of a utf-8 sequnce for a Unnicode character. - \param uc[in] Unicode characte + \param[in] uc Unicode characte \return length of the sequence in bytes */ //FL_EXPORT int fl_utf8_size(Fl_Unichar uc); |