Don't attribute in file headers anymore. See llvmdev for the
[oota-llvm.git] / include / llvm / System / Alarm.h
index b2a76bb9c526031e227a1ba2eacf6768d426e0f9..708472ceee3497e4f4c1710e9e1139f102b2fde1 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencer and is distributed under the
-// University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 #ifndef LLVM_SYSTEM_ALARM_H
 #define LLVM_SYSTEM_ALARM_H
 
+#include "llvm/System/IncludeFile.h"
+
 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
@@ -39,4 +44,6 @@ namespace sys {
 } // End sys namespace
 } // End llvm namespace
 
+FORCE_DEFINING_FILE_TO_BE_LINKED(SystemAlarm)
+
 #endif