diff options
| author | engelsman <engelsman> | 2008-10-04 15:54:15 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2008-10-04 15:54:15 +0000 |
| commit | c28c0de681381267b2d616aeb339d206cffeae31 (patch) | |
| tree | 690aa75ccd1e5776d4ba7fc51588467ac0b1b377 /src | |
| parent | 7fc0d4903ddf8c10ce1b87880bc3832c405e713d (diff) | |
added doxygen comments for undocumented features in Fl, Fl_Gl_Window
- I see Fabien was/is? busy with Fl.H, so I submit the few changes
I've made and hope I haven't trodden on his toes too much :-)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6374 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src')
| -rw-r--r-- | src/Fl_add_idle.cxx | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/src/Fl_add_idle.cxx b/src/Fl_add_idle.cxx index 3581ff926..2debb3f53 100644 --- a/src/Fl_add_idle.cxx +++ b/src/Fl_add_idle.cxx @@ -50,21 +50,21 @@ static void call_idle() { } /** - Adds a callback function that is called every time by - Fl::wait() and also makes it act as though the timeout is - zero (this makes Fl::wait() return immediately, so if it is - in a loop it is called repeatedly, and thus the idle fucntion is - called repeatedly). The idle function can be used to get background - processing done. + Adds a callback function that is called every time by Fl::wait() and also + makes it act as though the timeout is zero (this makes Fl::wait() return + immediately, so if it is in a loop it is called repeatedly, and thus the + idle fucntion is called repeatedly). The idle function can be used to get + background processing done. - <P>You can have multiple idle callbacks. To remove an idle callback use Fl::remove_idle(). + You can have multiple idle callbacks. To remove an idle callback use + Fl::remove_idle(). - <P>Fl::wait() and Fl::check() call idle callbacks, - but Fl::ready() does not. + Fl::wait() and Fl::check() call idle callbacks, but Fl::ready() does not. - <P>The idle callback can call any FLTK functions, including - Fl::wait(), Fl::check(), and Fl::ready(). - FLTK will not recursively call the idle callback. + The idle callback can call any FLTK functions, including Fl::wait(), + Fl::check(), and Fl::ready(). + + FLTK will not recursively call the idle callback. */ void Fl::add_idle(void (*cb)(void*), void* data) { idle_cb* p = freelist; @@ -83,7 +83,9 @@ void Fl::add_idle(void (*cb)(void*), void* data) { } } -/** Returns true if the specified idle callback is currently installed. */ +/** + Returns true if the specified idle callback is currently installed. +*/ int Fl::has_idle(void (*cb)(void*), void* data) { idle_cb* p = first; if (!p) return 0; @@ -93,7 +95,9 @@ int Fl::has_idle(void (*cb)(void*), void* data) { } } -/** Removes the specified idle callback, if it is installed. */ +/** + Removes the specified idle callback, if it is installed. +*/ void Fl::remove_idle(void (*cb)(void*), void* data) { idle_cb* p = first; if (!p) return; |
