diff options
| author | Fabien Costantini <fabien@onepost.net> | 2009-03-24 01:40:44 +0000 |
|---|---|---|
| committer | Fabien Costantini <fabien@onepost.net> | 2009-03-24 01:40:44 +0000 |
| commit | 15489bda1b2c9a4db82965a85634674d5d7f2dbe (patch) | |
| tree | 0bd04bb1d127ad7aca0d09141993c32a20c2eb10 /src/fl_draw.cxx | |
| parent | 2fb4b11e9140cbf7bc19c566c71cdb935296b4e3 (diff) | |
Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6716 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_draw.cxx')
| -rw-r--r-- | src/fl_draw.cxx | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/fl_draw.cxx b/src/fl_draw.cxx index ca5b0b9a6..b8cb64994 100644 --- a/src/fl_draw.cxx +++ b/src/fl_draw.cxx @@ -102,7 +102,7 @@ static bool handle_utf8_seq(const char * &s,char * &d) { } /** - Copy \a from to \a buf, replacing unprintable characters with ^X and \\nnn. + Copy \p from to \p buf, replacing unprintable characters with ^X and \\nnn. Stop at a newline or if MAXBUF characters written to buffer. Also word-wrap if width exceeds maxw. @@ -178,7 +178,7 @@ fl_expand_text(const char* from, char* buf, int maxbuf, double maxw, int& n, /** The same as fl_draw(const char*,int,int,int,int,Fl_Align,Fl_Image*,int) with - the addition of the \a callthis parameter, which is a pointer to a text drawing + 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 */ void fl_draw( @@ -333,11 +333,11 @@ void fl_draw( 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 \a align. The value FL_ALIGN_INSIDE + 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 \a img is provided and is not \a NULL, the image is drawn above or - below the text as specified by the \a align value. - The \a draw_symbols argument specifies whether or not to look for symbol + 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' The text length is limited to 1024 characters per line. */ @@ -356,7 +356,7 @@ void fl_draw( /** Measure how wide and tall the string will be when printed by the - fl_draw() function with \a align parameter. If the incoming \a w + fl_draw() function with \p align parameter. If the incoming \p w is non-zero it will wrap to that width. \param[in] str nul-terminated string \param[out] w,h width and height of string in current font |