added doxygen comments for more functions in fl_draw.H

FL/fl_draw.H: see below
src/fl_cursor.cxx: fl_cursor()
src/fl_scroll_area.cxx: fl_scroll()
src/fl_overlay.cxx: fl_overlay_clear(), fl_overlay_rect()
documentation/src/drawing.dox: updated paragraph tag links



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

1 files changed, 9 insertions, 1 deletions

diff --git a/src/fl_shortcut.cxx b/src/fl_shortcut.cxx
index b638e9101..b0519d14f 100644
--- a/src/fl_shortcut.cxx
+++ b/src/fl_shortcut.cxx
@@ -133,7 +133,15 @@ static Keyname table[] = {
 };
 #endif
 
-const char * fl_shortcut_label(int shortcut) {
+/**
+  Get a human-readable string from a shortcut value.
+  Unparse a shortcut value as used by Fl_Button or Fl_Menu_Item into
+  a human-readable string like "Alt+N". This only works if the shortcut
+  is a character key or a numbered function key. If the shortcut is
+  zero then an empty string is returned. The return value points at
+  a static buffer that is overwritten with each call.
+  */
+const char* fl_shortcut_label(int shortcut) {
   static char buf[20];
   char *p = buf;
   if (!shortcut) {*p = 0; return buf;}