Fixed typos and amended doxygen docs.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6558 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2008-12-07 14:48:11 +00:00
parent 609f519533
commit 8a6a945505
4 changed files with 16 additions and 15 deletions

View File

@ -49,7 +49,7 @@ static double _fl_hypot(double x, double y) {
\param[in] x,y,r center and radius of circular 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 \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 counter-clockwise from 3 o'clock. If \a end is less than \a start
then it draws the ark in a clockwise direction. then it draws the arc in a clockwise direction.
*/ */
void fl_arc(double x, double y, double r, double start, double end) { void fl_arc(double x, double y, double r, double start, double end) {

View File

@ -56,9 +56,9 @@
much nicer small circles, since the small sizes are often hard-coded bitmaps. much nicer small circles, since the small sizes are often hard-coded bitmaps.
If a complete circle is drawn it will fit inside the passed bounding box. If a complete circle is drawn it will fit inside the passed bounding box.
The two angles are measured in degrees counterclockwise from 3'oclock and The two angles are measured in degrees counterclockwise from 3 o'clock and
are the starting and ending angle of the arc, a2 must be greater or equal are the starting and ending angle of the arc, \a a2 must be greater or equal
to a1. to \a a1.
fl_arc() draws a series of lines to approximate the arc. Notice that the fl_arc() draws a series of lines to approximate the arc. Notice that the
integer version of fl_arc() has a different number of arguments than the integer version of fl_arc() has a different number of arguments than the
@ -66,8 +66,8 @@
\param[in] x,y,w,h bounding box of complete circle \param[in] x,y,w,h bounding box of complete circle
\param[in] a1,a2 start and end angles of arc measured in degrees \param[in] a1,a2 start and end angles of arc measured in degrees
counter-clockwise from 3 o'clock. a2 must be greater counter-clockwise from 3 o'clock. \a a2 must be greater
than or equal to a1. than or equal to \a a1.
*/ */
void fl_arc(int x,int y,int w,int h,double a1,double a2) { void fl_arc(int x,int y,int w,int h,double a1,double a2) {
if (w <= 0 || h <= 0) return; if (w <= 0 || h <= 0) return;
@ -105,14 +105,14 @@ void fl_arc(int x,int y,int w,int h,double a1,double a2) {
/** /**
Draw filled ellipse sections using integer coordinates. Draw filled ellipse sections using integer coordinates.
Like fl_arc, but fl_pie() draws a filled-in pie slice. Like fl_arc(), but fl_pie() draws a filled-in pie slice.
This slice may extend outside the line drawn by fl_arc; This slice may extend outside the line drawn by fl_arc();
to avoid this use w - 1 and h - 1. to avoid this use w - 1 and h - 1.
\param[in] x,y,w,h bounding box of complete circle \param[in] x,y,w,h bounding box of complete circle
\param[in] a1,a2 start and end angles of arc measured in degrees \param[in] a1,a2 start and end angles of arc measured in degrees
counter-clockwise from 3 o'clock. a2 must be greater counter-clockwise from 3 o'clock. \a a2 must be greater
than or equal to a1. than or equal to \a a1.
*/ */
void fl_pie(int x,int y,int w,int h,double a1,double a2) { void fl_pie(int x,int y,int w,int h,double a1,double a2) {
if (w <= 0 || h <= 0) return; if (w <= 0 || h <= 0) return;

View File

@ -288,7 +288,7 @@ void fl_beep(int type) {
} }
#endif // WIN32 #endif // WIN32
} }
/** Shows an information message dialog box /** Shows an information message dialog box
\param[in] fmt can be used as an sprintf-like format and variables for the message text \param[in] fmt can be used as an sprintf-like format and variables for the message text
*/ */
void fl_message(const char *fmt, ...) { void fl_message(const char *fmt, ...) {
@ -391,9 +391,10 @@ const char* fl_input(const char *fmt, const char *defstr, ...) {
return r; return r;
} }
/** Shows an input dialog displaying the \a fmt message, /** Shows an input dialog displaying the \a fmt message.
like fl_input except the input text is not shown,
'*' characters are displayed instead Like fl_input() except the input text is not shown,
'*' characters are displayed instead.
\param[in] fmt can be used as an sprintf-like format and variables for the message text \param[in] fmt can be used as an sprintf-like format and variables for the message text
\param[in] defstr defines the default returned string if no text is entered \param[in] defstr defines the default returned string if no text is entered
\return the user string input if OK was pushed, NULL if Cancel was pushed \return the user string input if OK was pushed, NULL if Cancel was pushed

View File

@ -408,7 +408,7 @@ void Fl::get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue) {
/** /**
Returns the weighted average color between the two given colors. Returns the weighted average color between the two given colors.
The red, green abd blue values are averages using the following formula: The red, green and blue values are averages using the following formula:
\code \code
color = color1 * weight + color2 * (1 - weight) color = color1 * weight + color2 * (1 - weight)
\endcode \endcode