Author: engelsman
Date: 2009-03-15 14:24:43 -0700 (Sun, 15 Mar 2009)
New Revision: 6692
Log:
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()
Modified:
branches/branch-1.3/FL/fl_draw.H
branches/branch-1.3/src/fl_symbols.cxx
Modified: branches/branch-1.3/FL/fl_draw.H
===================================================================
--- branches/branch-1.3/FL/fl_draw.H 2009-03-15 21:16:34 UTC (rev 6691)
+++ branches/branch-1.3/FL/fl_draw.H 2009-03-15 21:24:43 UTC (rev 6692)
@@ -444,8 +444,11 @@
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);
Modified: branches/branch-1.3/src/fl_symbols.cxx
===================================================================
--- branches/branch-1.3/src/fl_symbols.cxx 2009-03-15 21:16:34 UTC (rev
6691)
+++ branches/branch-1.3/src/fl_symbols.cxx 2009-03-15 21:24:43 UTC (rev
6692)
@@ -77,8 +77,14 @@
/**************** 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_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;
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
