Fix documentation for the AlarmSetup function.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24940 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Reid Spencer 2005-12-22 03:57:15 +00:00
parent a0a11d289d
commit 65f6ad804e

View File

@ -21,8 +21,11 @@ namespace llvm {
namespace sys {
/// This function registers an alarm to trigger some number of \p seconds in
/// the future. When that time arrives, the \p callback is called. You can
/// only call this once. Each time
/// the future. When that time arrives, the AlarmStatus function will begin
/// to return 1 instead of 0. The user must poll the status of the alarm by
/// making occasional calls to AlarmStatus. If the user sends an interrupt
/// signal, AlarmStatus will begin returning -1, even if the alarm event
/// occurred.
/// @returns nothing
void SetupAlarm(
unsigned seconds ///< Number of seconds in future when alarm arrives