diff options
| author | Reid Spencer <rspencer@reidspencer.com> | 2005-12-22 03:57:15 +0000 |
|---|---|---|
| committer | Reid Spencer <rspencer@reidspencer.com> | 2005-12-22 03:57:15 +0000 |
| commit | 65f6ad804e2e2d20512421bac598dcc291bfaa89 (patch) | |
| tree | 70ce1a5d8acc6b650fdd2252ecdc51172bb11b4b /include/llvm/System | |
| parent | a0a11d289d3cdbff78c1c1e570920d5645f28146 (diff) | |
| download | external_llvm-65f6ad804e2e2d20512421bac598dcc291bfaa89.zip external_llvm-65f6ad804e2e2d20512421bac598dcc291bfaa89.tar.gz external_llvm-65f6ad804e2e2d20512421bac598dcc291bfaa89.tar.bz2 | |
Fix documentation for the AlarmSetup function.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24940 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/System')
| -rw-r--r-- | include/llvm/System/Alarm.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/llvm/System/Alarm.h b/include/llvm/System/Alarm.h index b2a76bb..ec44a6d 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 |