Mirrors_UI_SDK/fltk
1
0
Fork 0
mirror of https://github.com/fltk/fltk.git synced 2026-06-04 06:56:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation: separate the doc of the 2 versions of Fl::add_fd() as Doxygen mandates.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12662 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Manolo Gouy
2018-02-10 17:51:17 +00:00
parent c489f3bf6a
commit 4dde3e5485
2 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FL/Fl.H
-20
View File
@@ -490,27 +490,7 @@ int main() {
static void remove_check(Fl_Timeout_Handler, void* = 0);
// private
static void run_checks();
/**
Adds file descriptor fd to listen to.
When the fd becomes ready for reading Fl::wait() will call the
callback and then return. The callback is passed the fd and the
arbitrary void* argument.
The second version takes a when bitfield, with the bits
FL_READ, FL_WRITE, and FL_EXCEPT defined,
to indicate when the callback should be done.
There can only be one callback of each type for a file descriptor.
Fl::remove_fd() gets rid of <I>all</I> the callbacks for a given
file descriptor.
Under UNIX <I>any</I> file descriptor can be monitored (files,
devices, pipes, sockets, etc.). Due to limitations in Microsoft Windows,
Windows applications can only monitor sockets.
*/
static void add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0); // platform dependent
/** See void add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0) */
static void add_fd(int fd, Fl_FD_Handler cb, void* = 0); // platform dependent
/** Removes a file descriptor handler. */
static void remove_fd(int, int when); // platform dependent
src/Fl.cxx
+22
View File
@@ -1974,11 +1974,33 @@ int Fl::clipboard_contains(const char *type)
}
/**
Adds file descriptor fd to listen to.
When the fd becomes ready for reading Fl::wait() will call the
callback and then return. The callback is passed the fd and the
arbitrary void* argument.
This version takes a when bitfield, with the bits
FL_READ, FL_WRITE, and FL_EXCEPT defined,
to indicate when the callback should be done.
There can only be one callback of each type for a file descriptor.
Fl::remove_fd() gets rid of <I>all</I> the callbacks for a given
file descriptor.
Under UNIX/Linux/MacOS <I>any</I> file descriptor can be monitored (files,
devices, pipes, sockets, etc.). Due to limitations in Microsoft Windows,
Windows applications can only monitor sockets.
*/
void Fl::add_fd(int fd, int when, Fl_FD_Handler cb, void *d)
{
Fl::system_driver()->add_fd(fd, when, cb, d);
}
/** Adds file descriptor fd to listen to.
See Fl::add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0)
for details */
void Fl::add_fd(int fd, Fl_FD_Handler cb, void *d)
{
Fl::system_driver()->add_fd(fd, cb, d);