[cfe-commits] r63228 - /cfe/trunk/include/clang/Basic/Diagnostic.h

[Ted Kremenek]

Author: kremenek
Date: Wed Jan 28 14:45:37 2009
New Revision: 63228

URL: http://llvm.org/viewvc/llvm-project?rev=63228&view=rev
Log:
Tweak doxygen comment.  No functionality change.

Modified:
    cfe/trunk/include/clang/Basic/Diagnostic.h

Modified: cfe/trunk/include/clang/Basic/Diagnostic.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/Diagnostic.h?rev=63228&r1=63227&r2=63228&view=diff

==============================================================================
--- cfe/trunk/include/clang/Basic/Diagnostic.h (original)
+++ cfe/trunk/include/clang/Basic/Diagnostic.h Wed Jan 28 14:45:37 2009
@@ -205,9 +205,11 @@
   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: