ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix doxygen warnings.

pull/4425/head
Sam Grove 2017-06-01 13:09:11 -05:00
parent 2d8bf18317
commit 0bf2c5f55c
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
platform/mbed_poll.h
View File

@ -39,13 +39,11 @@ struct pollfh {
* For every file handle provided, poll() examines it for any events registered for that particular * For every file handle provided, poll() examines it for any events registered for that particular
* file handle. * file handle.
* *
* @param fhs, an array of PollFh struct carrying a FileHandle and bitmasks of events * @param fhs an array of PollFh struct carrying a FileHandle and bitmasks of events
* @param nhfs, number of file handles * @param nfhs number of file handles
* @param timeout, timer value to timeout or -1 for loop forever * @param timeout timer value to timeout or -1 for loop forever
* *
* @return number of file handles selected (for which revents is non-zero). * @return number of file handles selected (for which revents is non-zero). 0 if timed out with nothing selected. -1 for error.
* @return 0 if timed out with nothing selected.
* @return -1 for error.
*/ */
int poll(pollfh fhs[], unsigned nfhs, int timeout); int poll(pollfh fhs[], unsigned nfhs, int timeout);