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 bea18eaff6779f62f694fdb36f614bf12e7203f7..84e23b1b337be37df4a9833700ad81872ae05d57 100644 (file)
--- 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 259e05b47341dcf7cb70f79a96c2080a8414490f..9bae0dff938a5ea073967562ff4e85bc10bce0be 100644 (file)
--- 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