sid
/
NazaraEngine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Network/SocketPoller: Fix documentation

This commit is contained in:
Jérôme Leclercq 2017-03-08 13:17:04 +01:00
parent 43f8f21df6
commit b0d61802b6
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Nazara/Network/SocketPoller.cpp
View File

@ -142,13 +142,15 @@ namespace Nz
}
/*!
* \brief Wait until any registered socket switches to a ready state
* \brief Wait until any registered socket switches to a ready state.
*
* Waits a specific/undetermined amount of time until at least one socket part of the SocketPoller becomes ready.
* To query the ready state of the registered socket, use the IsReady function.
*
* \param msTimeout Maximum time to wait in milliseconds, 0 for infinity
*
* \return True if at least one socket registered to the poller is ready.
*
* \remark It is an error to try to unregister a non-registered socket from a SocketPoller.
*
* \see IsReady