From 065cfaadbe31f61dc5530b3dc4bf6ec6293cb1a8 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Wed, 15 Oct 2008 21:38:38 +0000
Subject: minor doxygen updates for fl_draw.H, fl_color.cxx and fl_vertex.cxx

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6442 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/fl_draw.H      |  3 ++-
 src/fl_color.cxx  | 12 +++++++++++-
 src/fl_vertex.cxx |  2 +-
 3 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index eb83c6f47..e5133421c 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -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_;
 /**
diff --git a/src/fl_color.cxx b/src/fl_color.cxx
index a3f82df19..b5b98401b 100644
--- a/src/fl_color.cxx
+++ b/src/fl_color.cxx
@@ -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) {
diff --git a/src/fl_vertex.cxx b/src/fl_vertex.cxx
index d563166e7..1a47a1c58 100644
--- a/src/fl_vertex.cxx
+++ b/src/fl_vertex.cxx
@@ -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
-- 
cgit v1.2.3