From 6eb194ae48657e3d12819e7d1b28c8b7550fb464 Mon Sep 17 00:00:00 2001
From: engelsman <engelsman>
Date: Sun, 15 Mar 2009 21:24:43 +0000
Subject: [PATCH] added doxygen comments for remaining functions in fl_draw.H

Fl/fl_draw.H: \todo for fl_set_status(), fl_set_spot(), fl_reset_spot()
src/fl_symbols.cxx: fl_add_symbol(), fl_draw_symbol()



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6692 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/fl_draw.H       |  3 +++
 src/fl_symbols.cxx | 16 +++++++++++++++-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/FL/fl_draw.H b/FL/fl_draw.H
index 67b8b7e9a..b4cbe2117 100644
--- a/FL/fl_draw.H
+++ b/FL/fl_draw.H
@@ -444,8 +444,11 @@ FL_EXPORT const char* fl_expand_text(const char* from, char* buf, int maxbuf,
                                      int wrap, int draw_symbols = 0);
 
 // XIM:
+/** \todo provide user documentation for fl_set_status function */
 FL_EXPORT void fl_set_status(int X, int Y, int W, int H);
+/** \todo provide user documentation for fl_set_spot function */
 FL_EXPORT void fl_set_spot(int font, int size, int X, int Y, int W, int H, Fl_Window *win=0);
+/** \todo provide user documentation for fl_reset_spot function*/
 FL_EXPORT void fl_reset_spot(void);
 
 
diff --git a/src/fl_symbols.cxx b/src/fl_symbols.cxx
index 33b98619d..b6bf369ed 100644
--- a/src/fl_symbols.cxx
+++ b/src/fl_symbols.cxx
@@ -77,8 +77,14 @@ static void fl_init_symbols(void);
 
 /**************** The routines seen by the user *************************/
 
+/**
+  Adds a symbol to the system.
+  \param[in] name     name of symbol (without the "@")
+  \param[in] drawit   function to draw symbol
+  \param[in] scalable set to 1 if \a drawit uses scalable vector drawing
+  \returns 1 on success, 0 on failure
+  */
 int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)
-/* Adds a symbol to the system. Returns whether correct. */
 {
   fl_init_symbols();
   int pos;
@@ -94,6 +100,14 @@ int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)
 
 int fl_return_arrow(int x,int y,int w,int h);
 
+/**
+  Draw the named symbol in the given rectangle using the given color
+  \param[in] label name of symbol
+  \param[in] x,y   position of symbol
+  \param[in] w,h   size of symbol
+  \param[in] col   color of symbox
+  \returns 1 on success, 0 on failure
+  */
 // provided for back compatibility:
 int fl_draw_symbol(const char *label,int x,int y,int w,int h,Fl_Color col) {  
   const char *p = label;