summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2009-07-08 17:09:18 +0000
committerChris Lattner <sabre@nondot.org>2009-07-08 17:09:18 +0000
commit9b4b741414e5733ae4bef81a2f6b49e91bf70ba3 (patch)
treeb59cb094a6be16a2e842bdc817dd7297c29c9677
parent8e0d04249d4aff89324a4d2d009401dfd262f7e1 (diff)
downloadbcm5719-llvm-9b4b741414e5733ae4bef81a2f6b49e91bf70ba3.tar.gz
bcm5719-llvm-9b4b741414e5733ae4bef81a2f6b49e91bf70ba3.zip
convert comments to doxygen style
llvm-svn: 75015
-rw-r--r--llvm/include/llvm/Support/ErrorHandling.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/llvm/include/llvm/Support/ErrorHandling.h b/llvm/include/llvm/Support/ErrorHandling.h
index dff5dd86368..fae7d8094b0 100644
--- a/llvm/include/llvm/Support/ErrorHandling.h
+++ b/llvm/include/llvm/Support/ErrorHandling.h
@@ -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;
}
OpenPOWER on IntegriCloud