From: Ted Kremenek Date: Wed, 28 Jan 2009 20:45:37 +0000 (+0000) Subject: Tweak doxygen comment. No functionality change. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=509355e982d15da4f8f3939493516379665f6275;p=clang Tweak doxygen comment. No functionality change. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@63228 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/include/clang/Basic/Diagnostic.h b/include/clang/Basic/Diagnostic.h index d1c045704a..c57e1a9a89 100644 --- a/include/clang/Basic/Diagnostic.h +++ b/include/clang/Basic/Diagnostic.h @@ -205,9 +205,11 @@ public: Level getDiagnosticLevel(unsigned DiagID) const; - /// Report - Issue the message to the client. DiagID is a member of the - /// diag::kind enum. This actually returns aninstance of DiagnosticBuilder - /// which emits the diagnostics (through ProcessDiag) when it is destroyed. + /// Report - Issue the message to the client. @c DiagID is a member of the + /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder + /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. + /// @c Pos represents the source location associated with the diagnostic, + /// which can be an invalid location if no position information is available. inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); private: