diff options
| -rw-r--r-- | FL/Fl_Chart.H | 2 | ||||
| -rw-r--r-- | FL/Fl_Widget.H | 16 | ||||
| -rw-r--r-- | TODO.osx | 7 | ||||
| -rw-r--r-- | documentation/Doxyfile | 2 | ||||
| -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 |
8 files changed, 36 insertions, 26 deletions
diff --git a/FL/Fl_Chart.H b/FL/Fl_Chart.H index 6f95b23ba..1d004e660 100644 --- a/FL/Fl_Chart.H +++ b/FL/Fl_Chart.H @@ -148,7 +148,7 @@ public: /** Set whether the chart will automatically adjust the bounds of the chart. - \param n non-zero to enable automatic resizing, zero to disable. + \param[in] n non-zero to enable automatic resizing, zero to disable. */ void autosize(uchar n) {autosize_ = n;} }; diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H index 9bd710c72..da55b227d 100644 --- a/FL/Fl_Widget.H +++ b/FL/Fl_Widget.H @@ -389,7 +389,7 @@ public: * This is generally used for special effects such as embossing or for using * the label() pointer as another form of data such as an icon. The value * FL_NORMAL_LABEL prints the label as plain text. - * \param a new label type + * \param[in] a new label type * \see Fl_Labeltype */ void labeltype(Fl_Labeltype a) {label_.type = a;} @@ -767,8 +767,8 @@ public: /** Sets the default callback for all widgets. * Sets the default callback, which puts a pointer to the widget on the queue * returned by Fl::readqueue(). You may want to call this from your own callback. - * \param cb the new callback - * \param d user data associated with that callback + * \param[in] cb the new callback + * \param[in] d user data associated with that callback * \see callback(), do_callback(), Fl::readqueu() */ static void default_callback(Fl_Widget *cb, void *d); @@ -783,8 +783,8 @@ public: /** Call the widget callback. * Causes a widget to invoke its callback function, optionally * with arbitrary arguments. - * \param o call the callback with \em o as the widget argument - * \param arg call the callback with \em arg as the user data argument + * \param[in] o call the callback with \em o as the widget argument + * \param[in] arg call the callback with \em arg as the user data argument * \see callback() */ void do_callback(Fl_Widget* o,void* arg=0) {callback_(o,arg); if (callback_ != default_callback) clear_changed();} @@ -792,8 +792,8 @@ public: /** Call the widget callback. * Causes a widget to invoke its callback function, optionally * with arbitrary arguments. - * \param o call the callback with \em o as the widget argument - * \param arg call the callback with \em arg as the user data argument + * \param[in] o call the callback with \em o as the widget argument + * \param[in] arg call the callback with \em arg as the user data argument * \see callback() */ void do_callback(Fl_Widget* o,long arg) {callback_(o,(void*)arg); if (callback_ != default_callback) clear_changed();} @@ -855,7 +855,7 @@ public: /** Set the damage bits for an area inside the widget. * Setting damage bits will schedule the widget for the next redraw. * \param[in] c bitmask of flags to set - * \param x, y, w, h size of damaged area + * \param[in] x, y, w, h size of damaged area * \see damage(), clear_damage(uchar) */ void damage(uchar c, int x, int y, int w, int h); diff --git a/TODO.osx b/TODO.osx new file mode 100644 index 000000000..a05acb3dd --- /dev/null +++ b/TODO.osx @@ -0,0 +1,7 @@ +Mac Os X platform impl. Todo List +================================= + +- Remove the enable-quartz option, only quartz shall be supported in 1.3 +- Clean up progressivelly old QD code (related to QD compilation only) +- Fix OS9/QD archaisms found in the current Quartz code +- Complete the Quartz Implemtation. diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 7972d709b..0a68f2e3a 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -472,7 +472,7 @@ WARNINGS = YES # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some 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); |