Fix documentation for the AlarmSetup function.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24940 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/System/Alarm.h b/include/llvm/System/Alarm.h
index b2a76bb9c526031e227a1ba2eacf6768d426e0f9..ec44a6df1e20de76335028b1e949f8c0554093bc 100644 (file)
--- 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