From: Eric Liu <ioeric@google.com>
Date: Tue, 15 Nov 2016 19:05:40 +0000 (+0000)
Subject: Add comments on how to print error retuned by tooling::Replacements::add().
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=510f4199c0a4ac7e68a40b18f7b3cb6a57a9f70a;p=clang

Add comments on how to print error retuned by tooling::Replacements::add().

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

diff --git a/include/clang/Tooling/Core/Replacement.h b/include/clang/Tooling/Core/Replacement.h
index 1442bebe9c..5bb1e7f023 100644
--- a/include/clang/Tooling/Core/Replacement.h
+++ b/include/clang/Tooling/Core/Replacement.h
@@ -164,8 +164,9 @@ class Replacements {
   /// it returns an llvm::Error, i.e. there is a conflict between R and the
   /// existing replacements (i.e. they are order-dependent) or R's file path is
   /// different from the filepath of existing replacements. Callers must
-  /// explicitly check the Error returned. This prevents users from adding
-  /// order-dependent replacements. To control the order in which
+  /// explicitly check the Error returned, and the returned error can be
+  /// converted to a string message with `llvm::toString()`. This prevents users
+  /// from adding order-dependent replacements. To control the order in which
   /// order-dependent replacements are applied, use merge({R}) with R referring
   /// to the changed code after applying all existing replacements.
   /// Two replacements A and B are considered order-independent if applying them