maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

IR: Fix up doxygen comment for LLVMContext::diagnose 

This comment was referring to the DiagnosticSeverity with RS_
prefixes, but they're actually DS_. I've also modernized the comment
style since I was changing it anyway.

llvm-svn: 214787
This commit is contained in:
Justin Bogner 2014-08-04 21:49:15 +00:00
parent 3de0853b47
commit ac021bac4e
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
llvm/include/llvm/IR/LLVMContext.h
View File

@ -114,14 +114,16 @@ public:
/// setDiagnosticContext.
void *getDiagnosticContext() const;
/// diagnose - Report a message to the currently installed diagnostic handler.
/// \brief Report a message to the currently installed diagnostic handler.
///
/// This function returns, in particular in the case of error reporting
/// (DI.Severity == RS_Error), so the caller should leave the compilation
/// (DI.Severity == \a DS_Error), so the caller should leave the compilation
/// process in a self-consistent state, even though the generated code
/// need not be correct.
/// The diagnostic message will be implicitly prefixed with a severity
/// keyword according to \p DI.getSeverity(), i.e., "error: "
/// for RS_Error, "warning: " for RS_Warning, and "note: " for RS_Note.
///
/// The diagnostic message will be implicitly prefixed with a severity keyword
/// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
/// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
void diagnose(const DiagnosticInfo &DI);
/// \brief Registers a yield callback with the given context.