Fix a bunch of -Wdocumentation warnings.

[oota-llvm.git] / include / llvm / Support / PrettyStackTrace.h

diff --git a/include/llvm/Support/PrettyStackTrace.h b/include/llvm/Support/PrettyStackTrace.h
index 909d286f28b63bcd7b400991844342ddd355c580..9b3ecda50c1e67a75b20eedc422599a6f382f897 100644 (file)
--- a/include/llvm/Support/PrettyStackTrace.h
+++ b/include/llvm/Support/PrettyStackTrace.h
@@ -18,10 +18,16 @@
 
 namespace llvm {
   class raw_ostream;
-  
+
+  /// DisablePrettyStackTrace - Set this to true to disable this module. This
+  /// might be necessary if the host application installs its own signal
+  /// handlers which conflict with the ones installed by this module.
+  /// Defaults to false.
+  extern bool DisablePrettyStackTrace;
+
   /// PrettyStackTraceEntry - This class is used to represent a frame of the
   /// "pretty" stack trace that is dumped when a program crashes. You can define
-  /// subclasses of this and declare them on the program stack: when they are 
+  /// subclasses of this and declare them on the program stack: when they are
   /// constructed and destructed, they will add their symbolic frames to a
   /// virtual stack trace.  This gets dumped out if the program crashes.
   class PrettyStackTraceEntry {
@@ -31,14 +37,14 @@ namespace llvm {
   public:
     PrettyStackTraceEntry();
     virtual ~PrettyStackTraceEntry();
-    
+
     /// print - Emit information about this stack frame to OS.
     virtual void print(raw_ostream &OS) const = 0;
-    
+
     /// getNextEntry - Return the next entry in the list of frames.
     const PrettyStackTraceEntry *getNextEntry() const { return NextEntry; }
   };
-  
+
   /// PrettyStackTraceString - This object prints a specified string (which
   /// should not contain newlines) to the stream as the stack trace when a crash
   /// occurs.
@@ -48,7 +54,7 @@ namespace llvm {
     PrettyStackTraceString(const char *str) : Str(str) {}
     virtual void print(raw_ostream &OS) const;
   };
-  
+
   /// PrettyStackTraceProgram - This object prints a specified program arguments
   /// to the stream as the stack trace when a crash occurs.
   class PrettyStackTraceProgram : public PrettyStackTraceEntry {
@@ -59,7 +65,7 @@ namespace llvm {
       : ArgC(argc), ArgV(argv) {}
     virtual void print(raw_ostream &OS) const;
   };
-  
+
 } // end namespace llvm
 
 #endif