summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2023-01-08 01:07:04 +0100
committerMatthias Melcher <github@matthiasm.com>2023-01-08 01:07:04 +0100
commit6ada45f1f24423c4039a5099fcc6de3b5e2c37f0 (patch)
treeb6f46ce27bcc96815d1db107969a1ed5de1981fa
parent8e16286ebbe0eee3d8d04789514b712cd5ae61a2 (diff)
Fix missing parameter documentation
-rw-r--r--FL/Fl_Widget.H10
-rw-r--r--src/Fl_Widget.cxx2
2 files changed, 8 insertions, 4 deletions
diff --git a/FL/Fl_Widget.H b/FL/Fl_Widget.H
index 772717856..1a5c9bb8b 100644
--- a/FL/Fl_Widget.H
+++ b/FL/Fl_Widget.H
@@ -963,18 +963,22 @@ public:
This is the same as calling
\code
- do_callback(this, user_data());
+ do_callback(this, user_data(), reason);
\endcode
+
+ \param[in] reason give a reason to why this callback was called, defaults to \ref FL_REASON_UNKNOWN
+
\see callback()
- \see do_callback(Fl_Widget *widget, void *data)
+ \see do_callback(Fl_Widget *widget, void *data, Fl_Callback_Reason reason), Fl_Callback_Reason
*/
void do_callback(Fl_Callback_Reason reason=FL_REASON_UNKNOWN) {do_callback(this, user_data_, reason);}
/** Calls the widget callback function with arbitrary arguments.
\param[in] widget call the callback with \p widget as the first argument
\param[in] arg call the callback with \p arg as the user data (second) argument
+ \param[in] reason give a reason to why this callback was called, defaults to \ref FL_REASON_UNKNOWN
\see callback()
- \see do_callback(Fl_Widget *widget, void *data)
+ \see do_callback(Fl_Widget *widget, void *data), Fl_Callback_Reason
*/
void do_callback(Fl_Widget *widget, long arg, Fl_Callback_Reason reason=FL_REASON_UNKNOWN) {
do_callback(widget, (void*)(fl_intptr_t)arg, reason);
diff --git a/src/Fl_Widget.cxx b/src/Fl_Widget.cxx
index f71b27927..6518f002f 100644
--- a/src/Fl_Widget.cxx
+++ b/src/Fl_Widget.cxx
@@ -383,7 +383,7 @@ void Fl_Widget::bind_deimage(Fl_Image* img) {
\param[in] widget call the callback with \p widget as the first argument
\param[in] arg use \p arg as the user data (second) argument
- \param[in] reason for calling this callback
+ \param[in] reason give a reason to why this callback was called, defaults to \ref FL_REASON_UNKNOWN
\see default_callback()
\see callback()