Fix a bunch of Doxygen syntax issues. Escape special characters,

[oota-llvm.git] / include / llvm / System / Signals.h

diff --git a/include/llvm/System/Signals.h b/include/llvm/System/Signals.h
index 588214eb4e67bb414955eee7c7bd7eb9191ce12c..197e4e1d2d61324eef79d4857b989a20be80f737 100644 (file)
--- a/include/llvm/System/Signals.h
+++ b/include/llvm/System/Signals.h
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group 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.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -23,19 +23,29 @@ namespace sys {
   /// This function registers signal handlers to ensure that if a signal gets
   /// delivered that the named file is removed.
   /// @brief Remove a file if a fatal signal occurs.
-  void RemoveFileOnSignal(const Path &Filename);
+  bool RemoveFileOnSignal(const Path &Filename, std::string* ErrMsg = 0);
 
   /// This function registers a signal handler to ensure that if a fatal signal
   /// gets delivered to the process that the named directory and all its
   /// contents are removed.
   /// @brief Remove a directory if a fatal signal occurs.
-  void RemoveDirectoryOnSignal(const Path& path);
+  bool RemoveDirectoryOnSignal(const Path& path, std::string* ErrMsg = 0);
 
   /// When an error signal (such as SIBABRT or SIGSEGV) is delivered to the
   /// process, print a stack trace and then exit.
   /// @brief Print a stack trace if a fatal signal occurs.
   void PrintStackTraceOnErrorSignal();
 
+  /// This function registers a function to be called when the user "interrupts"
+  /// the program (typically by pressing ctrl-c).  When the user interrupts the
+  /// program, the specified interrupt function is called instead of the program
+  /// being killed, and the interrupt function automatically disabled.  Note
+  /// that interrupt functions are not allowed to call any non-reentrant
+  /// functions.  An null interrupt function pointer disables the current
+  /// installed function.  Note also that the handler may be executed on a
+  /// different thread on some platforms.
+  /// @brief Register a function to be called when ctrl-c is pressed.
+  void SetInterruptFunction(void (*IF)());
 } // End sys namespace
 } // End llvm namespace