From b6017b03dab80e1e7bfeec4e7debff0fefa9563e Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Wed, 8 Jul 2009 17:09:18 +0000 Subject: [PATCH] convert comments to doxygen style git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75015 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Support/ErrorHandling.h | 38 ++++++++++++++-------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/include/llvm/Support/ErrorHandling.h b/include/llvm/Support/ErrorHandling.h index dff5dd86368..fae7d8094b0 100644 --- a/include/llvm/Support/ErrorHandling.h +++ b/include/llvm/Support/ErrorHandling.h @@ -19,33 +19,33 @@ #include 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; } -- 2.34.1