From: Chandler Carruth <chandlerc@gmail.com>
Date: Sun, 16 Oct 2011 06:24:58 +0000 (+0000)
Subject: Add proper doxyments to the entry point routine, and remove a dead parameter.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2ed3495278c13802a3d85578ab20560dcb0ef270;p=clang

Add proper doxyments to the entry point routine, and remove a dead parameter.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@142109 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/clang/Frontend/TextDiagnostic.h b/include/clang/Frontend/TextDiagnostic.h
index bea18eaff6..84e23b1b33 100644
--- a/include/clang/Frontend/TextDiagnostic.h
+++ b/include/clang/Frontend/TextDiagnostic.h
@@ -72,10 +72,21 @@ public:
                  const LangOptions &LangOpts,
                  const DiagnosticOptions &DiagOpts);
 
+  /// \brief Emit a textual diagnostic.
+  ///
+  /// This is the primary entry point for emitting textual diagnostic messages.
+  /// It handles formatting and printing the message as well as any ancillary
+  /// information needed based on macros whose expansions impact the
+  /// diagnostic.
+  ///
+  /// \param Loc The location for this caret.
+  /// \param Level The level of the diagnostic to be emitted.
+  /// \param Message The diagnostic message to emit.
+  /// \param Ranges The underlined ranges for this code snippet.
+  /// \param FixItHints The FixIt hints active for this diagnostic.
   void emitDiagnostic(SourceLocation Loc, DiagnosticsEngine::Level Level,
                       StringRef Message, ArrayRef<CharSourceRange> Ranges,
-                      ArrayRef<FixItHint> FixItHints,
-                      bool LastCaretDiagnosticWasNote = false);
+                      ArrayRef<FixItHint> FixItHints);
 
   /// \brief Print the diagonstic level to a raw_ostream.
   ///
diff --git a/lib/Frontend/TextDiagnostic.cpp b/lib/Frontend/TextDiagnostic.cpp
index 259e05b473..9bae0dff93 100644
--- a/lib/Frontend/TextDiagnostic.cpp
+++ b/lib/Frontend/TextDiagnostic.cpp
@@ -400,8 +400,7 @@ void TextDiagnostic::emitDiagnostic(SourceLocation Loc,
                                     DiagnosticsEngine::Level Level,
                                     StringRef Message,
                                     ArrayRef<CharSourceRange> Ranges,
-                                    ArrayRef<FixItHint> FixItHints,
-                                    bool LastCaretDiagnosticWasNote) {
+                                    ArrayRef<FixItHint> FixItHints) {
   PresumedLoc PLoc = getDiagnosticPresumedLoc(SM, Loc);
 
   // First, if this diagnostic is not in the main file, print out the