From 589c1f31c313e1b9630b63a5cd91de6a1ff8872d Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Sun, 5 Feb 2023 11:45:23 +0100
Subject: Improve doc of Fl_Widget::test_shortcut() methods

This removes a \todo item.
---
 src/fl_shortcut.cxx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/fl_shortcut.cxx b/src/fl_shortcut.cxx
index d0e95bf38..014fd2637 100644
--- a/src/fl_shortcut.cxx
+++ b/src/fl_shortcut.cxx
@@ -329,7 +329,7 @@ unsigned int Fl_Widget::label_shortcut(const char *t) {
   \return true, if the entered text matches the '&x' shortcut in \p t
           false (0) otherwise.
 
-  \note Internal use only.
+  \note Useful when a widget's handle(int) method needs dedicated processing of FL_SHORTCUT.
 */
 int Fl_Widget::test_shortcut(const char *t, const bool require_alt) {
   static int extra_test = Fl::system_driver()->need_test_shortcut_extra();
@@ -363,7 +363,7 @@ int Fl_Widget::test_shortcut(const char *t, const bool require_alt) {
   \return true, if the entered text matches the widget's'&x' shortcut,
           false (0) otherwise.
 
-  \note Internal use only.
+ \note Useful when a widget's handle(int) method needs dedicated processing of FL_SHORTCUT.
 */
 
 int Fl_Widget::test_shortcut() {
-- 
cgit v1.2.3