From 4bcf3e531183b0533baa114b8456d89cdb8ebcd6 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Sun, 15 Mar 2009 20:52:46 +0000
Subject: 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
---
 src/fl_cursor.cxx      |  4 ++++
 src/fl_overlay.cxx     |  6 ++++++
 src/fl_scroll_area.cxx | 13 ++++++++++++-
 src/fl_shortcut.cxx    | 10 +++++++++-
 4 files changed, 31 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/fl_cursor.cxx b/src/fl_cursor.cxx
index e5318bb01..2cdf8d41b 100644
--- a/src/fl_cursor.cxx
+++ b/src/fl_cursor.cxx
@@ -39,6 +39,10 @@
 #endif
 #include <FL/fl_draw.H>
 
+/**
+  Sets the cursor for the current window to the specified shape and colors.
+  The cursors are defined in the <FL/Enumerations.H> header file. 
+  */
 void fl_cursor(Fl_Cursor c, Fl_Color fg, Fl_Color bg) {
   if (Fl::first_window()) Fl::first_window()->cursor(c,fg,bg);
 }
diff --git a/src/fl_overlay.cxx b/src/fl_overlay.cxx
index 7d09c4654..a482e4dee 100644
--- a/src/fl_overlay.cxx
+++ b/src/fl_overlay.cxx
@@ -103,10 +103,16 @@ static void erase_current_rect() {
 #endif
 }
 
+/**
+  Erase a selection rectangle without drawing a new one
+  */
 void fl_overlay_clear() {
   if (pw > 0) {erase_current_rect(); pw = 0;}
 }
 
+/**
+  Draws a selection rectangle, erasing a previous one by XOR'ing it first.
+  */
 void fl_overlay_rect(int x, int y, int w, int h) {
   if (w < 0) {x += w; w = -w;} else if (!w) w = 1;
   if (h < 0) {y += h; h = -h;} else if (!h) h = 1;
diff --git a/src/fl_scroll_area.cxx b/src/fl_scroll_area.cxx
index 9dad3e7d4..4a361c37a 100644
--- a/src/fl_scroll_area.cxx
+++ b/src/fl_scroll_area.cxx
@@ -35,8 +35,19 @@
 #include <FL/fl_draw.H>
 
 // scroll a rectangle and redraw the newly exposed portions:
+/**
+  Scroll a rectangle and draw the newly exposed portions.
+  \param[in] X,Y       position of top-left of rectangle
+  \param[in] W,H       size of rectangle
+  \param[in] dx,dy     pixel offsets for shifting rectangle
+  \param[in] draw_area callback function to draw rectangular areas
+  \param[in] data      pointer to user data for callback
+  The contents of the rectangular area is first shifted by \a dx
+  and \a dy pixels. The \a draw_area callback is then called for
+  every newly exposed rectangular area.
+  */
 void fl_scroll(int X, int Y, int W, int H, int dx, int dy,
-	       void (*draw_area)(void*, int,int,int,int), void* data)
+               void (*draw_area)(void*, int,int,int,int), void* data)
 {
   if (!dx && !dy) return;
   if (dx <= -W || dx >= W || dy <= -H || dy >= H) {
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;}
-- 
cgit v1.2.3