From 65f6ad804e2e2d20512421bac598dcc291bfaa89 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Thu, 22 Dec 2005 03:57:15 +0000 Subject: [PATCH] Fix documentation for the AlarmSetup function. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24940 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/System/Alarm.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/include/llvm/System/Alarm.h b/include/llvm/System/Alarm.h index b2a76bb9c52..ec44a6df1e2 100644 --- a/include/llvm/System/Alarm.h +++ b/include/llvm/System/Alarm.h @@ -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