diff options
| author | engelsman <engelsman> | 2009-03-15 21:24:43 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2009-03-15 21:24:43 +0000 |
| commit | 6eb194ae48657e3d12819e7d1b28c8b7550fb464 (patch) | |
| tree | 08086e430193e81e23df2ba5b9aafa48f142174b /src/fl_symbols.cxx | |
| parent | 023b77a1abb294aef53b2f9f1babf464548283e4 (diff) | |
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
Diffstat (limited to 'src/fl_symbols.cxx')
| -rw-r--r-- | src/fl_symbols.cxx | 16 |
1 files changed, 15 insertions, 1 deletions
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; |