summaryrefslogtreecommitdiff
path: root/src/fl_color.cxx
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2009-03-24 01:40:44 +0000
committerFabien Costantini <fabien@onepost.net>2009-03-24 01:40:44 +0000
commit15489bda1b2c9a4db82965a85634674d5d7f2dbe (patch)
tree0bd04bb1d127ad7aca0d09141993c32a20c2eb10 /src/fl_color.cxx
parent2fb4b11e9140cbf7bc19c566c71cdb935296b4e3 (diff)
Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6716 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_color.cxx')
-rw-r--r--src/fl_color.cxx10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/fl_color.cxx b/src/fl_color.cxx
index 94afa5547..93c3cd470 100644
--- a/src/fl_color.cxx
+++ b/src/fl_color.cxx
@@ -322,7 +322,7 @@ Fl_Color fl_color_;
/**
Sets the color for all subsequent drawing operations.
For colormapped displays, a color cell will be allocated out of
- \a fl_colormap the first time you use a color. If the colormap fills up
+ \p fl_colormap the first time you use a color. If the colormap fills up
then a least-squares algorithm is used to find the closest color.
If no valid graphical context (fl_gc) is available,
the foreground is not set for the current window.
@@ -340,7 +340,7 @@ void fl_color(Fl_Color i) {
}
/**
- Free color \a i if used, and clear mapping table entry.
+ Free color \p i if used, and clear mapping table entry.
\param[in] i color index
\param[in] overlay 0 for normal, 1 for overlay color
*/
@@ -364,7 +364,7 @@ void Fl::free_color(Fl_Color i, int overlay) {
}
/**
- Set color mapping table entry \a i to color \a c
+ Set color mapping table entry \p i to color \p c
\param[in] i color index
\param[in] c color
*/
@@ -420,7 +420,7 @@ void Fl::get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue) {
\code
color = color1 * weight + color2 * (1 - weight)
\endcode
- Thus, a \a weight value of 1.0 will return the first color, while a
+ Thus, a \p weight value of 1.0 will return the first color, while a
value of 0.0 will return the second color.
\param[in] color1, color2 boundary colors
\param[in] weight weighting factor
@@ -453,7 +453,7 @@ Fl_Color fl_inactive(Fl_Color c) {
/**
Returns a color that contrasts with the background color.
This will be the foreground color if it contrasts sufficiently with the
- background color. Otherwise, returns \a FL_WHITE or \a FL_BLACK depending
+ background color. Otherwise, returns \p FL_WHITE or \p FL_BLACK depending
on which color provides the best contrast.
\param[in] fg,bg foreground and background colors
\return contrasting color