[llvm-commits] [llvm] r75015 - /llvm/trunk/include/llvm/Support/ErrorHandling.h

[Chris Lattner]

Author: lattner
Date: Wed Jul  8 12:09:18 2009
New Revision: 75015

URL: http://llvm.org/viewvc/llvm-project?rev=75015&view=rev
Log:
convert comments to doxygen style

Modified:
    llvm/trunk/include/llvm/Support/ErrorHandling.h

Modified: llvm/trunk/include/llvm/Support/ErrorHandling.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/ErrorHandling.h?rev=75015&r1=75014&r2=75015&view=diff

==============================================================================
--- llvm/trunk/include/llvm/Support/ErrorHandling.h (original)
+++ llvm/trunk/include/llvm/Support/ErrorHandling.h Wed Jul  8 12:09:18 2009
@@ -19,33 +19,33 @@
 #include <string>
 
 namespace llvm {
-  // An error handler callback.
+  /// An error handler callback.
   typedef void (*llvm_error_handler_t)(const std::string& reason);
 
-  // Installs a new error handler: this function will be called whenever a
-  // serious error is encountered by LLVM.
-  // If you are using llvm_start_multithreaded, you should register the handler
-  // before doing that.
-  //
-  // If no error handler is installed the default is to print the error message
-  // to stderr, and call exit(1).
-  // If an error handler is installed then it is the handler's responsibility to
-  // log the message, it will no longer be printed to stderr.
-  // If the error handler returns, then exit(1) will be called.
+  /// Installs a new error handler: this function will be called whenever a
+  /// serious error is encountered by LLVM.
+  /// If you are using llvm_start_multithreaded, you should register the handler
+  /// before doing that.
+  ///
+  /// If no error handler is installed the default is to print the error message
+  /// to stderr, and call exit(1).
+  /// If an error handler is installed then it is the handler's responsibility
+  /// to log the message, it will no longer be printed to stderr.
+  /// If the error handler returns, then exit(1) will be called.
   void llvm_install_error_handler(llvm_error_handler_t handler);
 
-  // Restores default error handling behaviour.
-  // This must not be called between llvm_start_multithreaded() and
-  // llvm_stop_multithreaded().
+  /// Restores default error handling behaviour.
+  /// This must not be called between llvm_start_multithreaded() and
+  /// llvm_stop_multithreaded().
   void llvm_remove_error_handler(void);
 
-  // Reports a serious error, calling any installed error handler.
-  // If no error handler is installed the default is to print the message to
+  /// Reports a serious error, calling any installed error handler.
+  /// If no error handler is installed the default is to print the message to
   void llvm_report_error(const std::string &reason) NORETURN;
 
-  // This function calls abort().
-  // Call this after assert(0), so that compiler knows the path is not
-  // reachable.
+  /// This function calls abort().
+  /// Call this after assert(0), so that compiler knows the path is not
+  /// reachable.
   void llvm_unreachable(void) NORETURN;
 }