summaryrefslogtreecommitdiff
path: root/src/fl_arc.cxx
diff options
context:
space:
mode:
authorengelsman <engelsman>2008-10-13 21:42:05 +0000
committerengelsman <engelsman>2008-10-13 21:42:05 +0000
commitde04c108f886dfdf8e4acffc0efd587ba5b77272 (patch)
tree110aaf3da82450a9ce5cf6ee55ca8baf7bb775a1 /src/fl_arc.cxx
parent8a20846803ea1d442c0eedc649cc6d4073bfa463 (diff)
copied more doxygen comments from drawing.dox back to source code
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6421 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_arc.cxx')
-rw-r--r--src/fl_arc.cxx14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/fl_arc.cxx b/src/fl_arc.cxx
index d4910aa1c..7d3872901 100644
--- a/src/fl_arc.cxx
+++ b/src/fl_arc.cxx
@@ -25,6 +25,11 @@
// http://www.fltk.org/str.php
//
+/**
+ \file fl_arc.cxx
+ \brief Utility functions for drawing arcs and circles.
+*/
+
// Utility for drawing arcs and circles. They are added to
// the current fl_begin/fl_vertex/fl_end path.
// Incremental math implementation:
@@ -38,7 +43,14 @@ static double _fl_hypot(double x, double y) {
return sqrt(x*x + y*y);
}
-
+/**
+ Add a series of points to the current path on the arc of a circle; you
+ can get elliptical paths by using scale and rotate before calling fl_arc().
+ \param[in] x,y,r center and radius of circular arc
+ \param[in] start,end angles of start and end of arc measured in degrees
+ counter-clockwise from 3 o'clock. If \a end is less than \a start
+ then it draws the ark in a clockwise direction.
+*/
void fl_arc(double x, double y, double r, double start, double end) {
// draw start point accurately: