From 4dde3e54855a2a8d1740f6006d9f17ec60075fbd Mon Sep 17 00:00:00 2001 From: Manolo Gouy Date: Sat, 10 Feb 2018 17:51:17 +0000 Subject: Documentation: separate the doc of the 2 versions of Fl::add_fd() as Doxygen mandates. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12662 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- src/Fl.cxx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'src') diff --git a/src/Fl.cxx b/src/Fl.cxx index 8c3c90069..4e040b30a 100644 --- a/src/Fl.cxx +++ b/src/Fl.cxx @@ -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 all the callbacks for a given + file descriptor. + + Under UNIX/Linux/MacOS any 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); -- cgit v1.2.3