[llvm-commits] CVS: llvm/include/llvm/System/Alarm.h

[Reid Spencer]

Changes in directory llvm/include/llvm/System:

Alarm.h updated: 1.1 -> 1.2
---
Log message:

Fix documentation for the AlarmSetup function.


---
Diffs of the changes:  (+5 -2)

 Alarm.h |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)


Index: llvm/include/llvm/System/Alarm.h
diff -u llvm/include/llvm/System/Alarm.h:1.1 llvm/include/llvm/System/Alarm.h:1.2
--- llvm/include/llvm/System/Alarm.h:1.1	Wed Dec 21 21:23:46 2005
+++ llvm/include/llvm/System/Alarm.h	Wed Dec 21 21:57:15 2005
@@ -21,8 +21,11 @@
 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