From 4bcf3e531183b0533baa114b8456d89cdb8ebcd6 Mon Sep 17 00:00:00 2001 From: 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_scroll_area.cxx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'src/fl_scroll_area.cxx') 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 // 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) { -- cgit v1.2.3