diff options
| author | ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> | 2024-08-28 10:05:17 +0200 |
|---|---|---|
| committer | ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> | 2024-08-28 10:05:17 +0200 |
| commit | b95a7eccd939fd3482604fdd9f56be3c6168bfcd (patch) | |
| tree | 6ae898a72490d36518176b2768e5819a41a011c9 /src/fl_draw.cxx | |
| parent | c7417f793f192993f2c6a2a1634ba1ec481d311e (diff) | |
Fix Doxygen problems with fl_draw() functions.
Diffstat (limited to 'src/fl_draw.cxx')
| -rw-r--r-- | src/fl_draw.cxx | 41 |
1 files changed, 4 insertions, 37 deletions
diff --git a/src/fl_draw.cxx b/src/fl_draw.cxx index 7f1b941ef..72823b078 100644 --- a/src/fl_draw.cxx +++ b/src/fl_draw.cxx @@ -189,21 +189,8 @@ fl_expand_text(const char* from, char* buf, int maxbuf, double maxw, int& n, return expand_text_(from, buf, maxbuf, maxw, n, width, wrap, draw_symbols); } -/** - The same as fl_draw(const char*,int,int,int,int,Fl_Align,Fl_Image*,int) with - the addition of the \p callthis parameter, which is a pointer to a text drawing - function such as fl_draw(const char*, int, int, int) to do the real work. - - \param[in] str UTF-8 string, can start and end with an '\@sym' symbol, - can contain '\\n' - \param[in] x,y,w,h bounding box - \param[in] align label and image alignment in bounding box - \param[in] callthis pointer to text drawing function - \param[in] img pointer to image - \param[in] draw_symbols if true, interprete leading and trailing '\@sym' - as graphical symbols - \param[in] spacing spacing between text and image - */ +// Caution: put the documentation next to the function's declaration in fl_draw.H for Doxygen +// to see default argument values. void fl_draw( const char* str, // the (multi-line) string int x, int y, int w, int h, // bounding box @@ -448,28 +435,8 @@ void fl_draw( } } -/** - Fancy string drawing function which is used to draw all the labels. - - The string is formatted and aligned inside the passed box. - Handles '\\t' and '\\n', expands all other control characters to '^X', - and aligns inside or against the edges of the box. - See Fl_Widget::align() for values of \p align. The value FL_ALIGN_INSIDE - is ignored, as this function always prints inside the box. - If \p img is provided and is not \p NULL, the image is drawn above or - below the text as specified by the \p align value. - The \p draw_symbols argument specifies whether or not to look for symbol - names starting with the '\@' character' - - \param[in] str UTF-8 string, can start and end with an '\@sym' symbol, - can contain '\\n' - \param[in] x,y,w,h bounding box - \param[in] align label and image alignment in bounding box - \param[in] img pointer to image - \param[in] draw_symbols if true, interprete leading and trailing '\@sym' - as graphical symbols - \param[in] spacing spacing between text and image - */ +// Caution: put the documentation next to the function's declaration in fl_draw.H for Doxygen +// to see default argument values. void fl_draw( const char* str, int x, int y, int w, int h, |
