mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed typos and amended doxygen docs.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6564 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2008-12-07 18:02:50 +00:00
parent eaf604b4ed
commit bdb7002d58
5 changed files with 30 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/fl_labeltype.cxx
View File

@ -82,7 +82,7 @@ void Fl::set_labeltype(Fl_Labeltype t,Fl_Label_Draw_F* f,Fl_Label_Measure_F*m)
////////////////////////////////////////////////////////////////
/** draw label with arbitrary alignment in arbitrary box */
/** Draws a label with arbitrary alignment in an arbitrary box. */
void Fl_Label::draw(int X, int Y, int W, int H, Fl_Align align) const {
if (!value && !image) return;
table[type](this, X, Y, W, H, align);

6
src/fl_line_style.cxx
View File

@ -27,7 +27,7 @@
/**
\file fl_line_style.cxx
\brief Line style drawing utility hiding different platforms.
\brief Line style drawing utility hiding different platforms.
*/
#include <FL/Fl.H>
@ -51,7 +51,7 @@ void fl_quartz_restore_line_style_() {
#endif
/**
Set how to draw lines (the "pen").
Sets how to draw lines (the "pen").
If you change this it is your responsibility to set it back to the default
using \c fl_line_style(0).
@ -65,7 +65,7 @@ void fl_quartz_restore_line_style_() {
different and nicer than 1.
\param[in] dashes A pointer to an array of dash lengths, measured in pixels.
The first location is how long to draw a solid portion, the next
is how long to draw the fap, then the solid, etc. It is terminated
is how long to draw the gap, then the solid, etc. It is terminated
with a zero-length entry. A \c NULL pointer or a zero-length
array results in a solid line. Odd array sizes are not supported
and result in undefined behavior.

45
src/fl_rect.cxx
View File

@ -46,7 +46,7 @@ extern float fl_quartz_line_width_;
#endif
/**
Draw a 1-pixel border \e inside the given bounding box
Draws a 1-pixel border \e inside the given bounding box
*/
void fl_rect(int x, int y, int w, int h) {
if (w<=0 || h<=0) return;
@ -69,7 +69,7 @@ void fl_rect(int x, int y, int w, int h) {
}
/**
Color a rectangle that exactly files the given bounding box
Colors a rectangle that exactly fills the given bounding box
*/
void fl_rectf(int x, int y, int w, int h) {
if (w<=0 || h<=0) return;
@ -91,7 +91,7 @@ void fl_rectf(int x, int y, int w, int h) {
}
/**
Draw horizontal line from x,y to x1,y
Draws a horizontal line from (x,y) to (x1,y)
*/
void fl_xyline(int x, int y, int x1) {
#if defined(USE_X11)
@ -110,7 +110,7 @@ void fl_xyline(int x, int y, int x1) {
}
/**
Draw horizontal line from x,y to x1,y, then vertical from x1,y to x1,y2
Draws a horizontal line from (x,y) to (x1,y), then vertical from (x1,y) to (x1,y2)
*/
void fl_xyline(int x, int y, int x1, int y2) {
#if defined (USE_X11)
@ -137,8 +137,8 @@ void fl_xyline(int x, int y, int x1, int y2) {
}
/**
Draw horizontal line from x,y to x1,y then a vertical from x1,y to x1,y2
and then another horizontal from x1,y2 to x3,y2
Draws a horizontal line from (x,y) to (x1,y), then a vertical from (x1,y) to (x1,y2)
and then another horizontal from (x1,y2) to (x3,y2)
*/
void fl_xyline(int x, int y, int x1, int y2, int x3) {
#if defined(USE_X11)
@ -168,7 +168,7 @@ void fl_xyline(int x, int y, int x1, int y2, int x3) {
}
/**
Draw a vertical line from x,y to x,y1
Draws a vertical line from (x,y) to (x,y1)
*/
void fl_yxline(int x, int y, int y1) {
#if defined(USE_X11)
@ -189,7 +189,7 @@ void fl_yxline(int x, int y, int y1) {
}
/**
Draw a vertical line from x,y to x,y1 then a horizontal from x,y1 to x2,y1
Draws a vertical line from (x,y) to (x,y1), then a horizontal from (x,y1) to (x2,y1)
*/
void fl_yxline(int x, int y, int y1, int x2) {
#if defined(USE_X11)
@ -216,8 +216,8 @@ void fl_yxline(int x, int y, int y1, int x2) {
}
/**
Draw a vertical line from x,y to x,y1 then a horizontal from x,y1 to x2,y1
then another vertical from x2,y1 to x2,y3
Draws a vertical line from (x,y) to (x,y1) then a horizontal from (x,y1)
to (x2,y1), then another vertical from (x2,y1) to (x2,y3)
*/
void fl_yxline(int x, int y, int y1, int x2, int y3) {
#if defined(USE_X11)
@ -247,7 +247,7 @@ void fl_yxline(int x, int y, int y1, int x2, int y3) {
}
/**
Draw a line from x,y to x1,y1
Draws a line from (x,y) to (x1,y1)
*/
void fl_line(int x, int y, int x1, int y1) {
#if defined(USE_X11)
@ -270,7 +270,7 @@ void fl_line(int x, int y, int x1, int y1) {
}
/**
Draw a line from x,y to x1,y1 and another from x1,y1 to x2,y2
Draws a line from (x,y) to (x1,y1) and another from (x1,y1) to (x2,y2)
*/
void fl_line(int x, int y, int x1, int y1, int x2, int y2) {
#if defined(USE_X11)
@ -299,7 +299,7 @@ void fl_line(int x, int y, int x1, int y1, int x2, int y2) {
}
/**
Outline a 3-sided polygon with lines
Outlines a 3-sided polygon with lines
*/
void fl_loop(int x, int y, int x1, int y1, int x2, int y2) {
#if defined(USE_X11)
@ -326,7 +326,7 @@ void fl_loop(int x, int y, int x1, int y1, int x2, int y2) {
}
/**
Outline a 4-sided polygon with lines
Outlines a 4-sided polygon with lines
*/
void fl_loop(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3) {
#if defined(USE_X11)
@ -356,7 +356,7 @@ void fl_loop(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3) {
}
/**
Fill a 3-sided polygon. The polygon must be convex.
Fills a 3-sided polygon. The polygon must be convex.
*/
void fl_polygon(int x, int y, int x1, int y1, int x2, int y2) {
XPoint p[4];
@ -382,7 +382,7 @@ void fl_polygon(int x, int y, int x1, int y1, int x2, int y2) {
}
/**
Fill a 4-sided polygon. The polygon must be convex.
Fills a 4-sided polygon. The polygon must be convex.
*/
void fl_polygon(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3) {
XPoint p[5];
@ -410,7 +410,7 @@ void fl_polygon(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3) {
}
/**
Draw a single pixel at the given coordinates
Draws a single pixel at the given coordinates
*/
void fl_point(int x, int y) {
#if defined(USE_X11)
@ -496,7 +496,8 @@ void fl_restore_clip() {
}
/**
Replace the top of the clipping stack with a clipping region of any shape.
Replaces the top of the clipping stack with a clipping region of any shape.
Fl_Region is an operating system specific type.
\param[in] r clipping region
*/
@ -515,7 +516,7 @@ Fl_Region fl_clip_region() {
}
/**
Intersect the current clip region with a rectangle and push this
Intersects the current clip region with a rectangle and pushes this
new region onto the stack.
\param[in] x,y,w,h position and size
*/
@ -567,7 +568,8 @@ void fl_push_no_clip() {
// pop back to previous clip:
/**
Restore the previous clip region.
Restores the previous clip region.
You must call fl_pop_clip() once for every time you call fl_push_clip().
Unpredictable results may occur if the clip stack is not empty when
you return to FLTK.
@ -612,8 +614,9 @@ int fl_not_clipped(int x, int y, int w, int h) {
// return rectangle surrounding intersection of this rectangle and clip:
/**
Intersect the rectangle with the current clip region and return the
Intersects the rectangle with the current clip region and returns the
bounding box of the result.
Returns non-zero if the resulting rectangle is different to the original.
This can be used to limit the necessary drawing to a rectangle.
\a W and \a H are set to zero if the rectangle is completely outside

2
src/fl_scroll_area.cxx
View File

@ -136,7 +136,7 @@ void fl_scroll(int X, int Y, int W, int H, int dx, int dy,
}
}
// Great, we can do an accelerated scroll insteasd of re-rendering
// Great, we can do an accelerated scroll instead of re-rendering
BitBlt(fl_gc, dest_x, dest_y, src_w, src_h, fl_gc, src_x, src_y,SRCCOPY);
#elif defined(__APPLE_QUARTZ__)

2
src/fl_set_font.cxx
View File

@ -86,7 +86,7 @@ void Fl::set_font(Fl_Font fnum, Fl_Font from) {
Fl::set_font(fnum, get_font(from));
}
/**
Get the string for this face. This string is different for each
Gets the string for this face. This string is different for each
face. Under X this value is passed to XListFonts to get all the sizes
of this face.
*/