gre-ilya/fltk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

minor doxygen updates for fl_draw.H, fl_color.cxx and fl_vertex.cxx

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6442 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
engelsman 2008-10-15 21:38:38 +00:00
parent 4f60171ba6
commit 065cfaadbe
3 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
FL/fl_draw.H
View File

@ -43,7 +43,8 @@ FL_EXPORT extern char fl_draw_shortcut;
// Colors:
FL_EXPORT void fl_color(Fl_Color i); // select indexed color
inline void fl_color(int c) {fl_color((Fl_Color)c);} // for back compatibility
/** for back compatibility - use fl_color(Fl_Color c) instead */
inline void fl_color(int c) {fl_color((Fl_Color)c);}
FL_EXPORT void fl_color(uchar r, uchar g, uchar b); // select actual color
extern FL_EXPORT Fl_Color fl_color_;
/**

12
src/fl_color.cxx
View File

@ -307,6 +307,11 @@ void fl_color(Fl_Color i) {
}
}
/**
Free color \a i if used, and clear mapping table entry.
\param[in] i color index
\param[in] overlay 0 for normal, 1 for overlay color
*/
void Fl::free_color(Fl_Color i, int overlay) {
# if HAVE_OVERLAY
# else
@ -326,6 +331,11 @@ void Fl::free_color(Fl_Color i, int overlay) {
}
}
/**
Set color mapping table entry \a i to color \a c
\param[in] i color index
\param[in] c color
*/
void Fl::set_color(Fl_Color i, unsigned c) {
if (fl_cmap[i] != c) {
free_color(i,0);
@ -344,7 +354,7 @@ void Fl::set_color(Fl_Color i, unsigned c) {
in the next 8 bits, and the blue value in bits 8-15. The lower
8 bits will always be 0.
<P>The second form returns the red, green, and blue values
The second form returns the red, green, and blue values
separately in referenced variables.
*/
unsigned Fl::get_color(Fl_Color i) {

2
src/fl_vertex.cxx
View File

@ -382,7 +382,7 @@ void fl_end_complex_polygon() {
// See fl_arc.c for portable version.
/**
fl_circle() is equivalent to fl_arc(...,0,360) but may be faster.
fl_circle() is equivalent to fl_arc(x,y,r,0,360) but may be faster.
It must be the \e only thing in the path: if you want a circle as part of
a complex polygon you must use fl_arc()
\param[in] x,y,r center and radius of circle