Added some extra doc examples for this function.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7496 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 10 insertions, 0 deletions

diff --git a/src/fl_shortcut.cxx b/src/fl_shortcut.cxx
index 013149d23..ecd47f158 100644
--- a/src/fl_shortcut.cxx
+++ b/src/fl_shortcut.cxx
@@ -269,6 +269,16 @@ const char* fl_shortcut_label(unsigned int shortcut, const char **eom) {
 #include <stdlib.h>
 /**
   Emulation of XForms named shortcuts.
+
+  Converts ascii shortcut specifications (eg. "^c") 
+  into the FLTK integer equivalent (eg. FL_CTRL+'c')
+
+  These ascii characters are used to specify the various keyboard modifier keys:
+  \verbatim
+   # - Alt
+   + - Shift
+   ^ - Control
+  \endverbatim
 */
 unsigned int fl_old_shortcut(const char* s) {
   if (!s || !*s) return 0;