From fafbd486ac1ed4b773f1ba9a106dda1a93169410 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Tue, 15 Nov 2016 19:05:40 +0000 Subject: [PATCH] Add comments on how to print error retuned by tooling::Replacements::add(). llvm-svn: 287008 --- clang/include/clang/Tooling/Core/Replacement.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/clang/include/clang/Tooling/Core/Replacement.h b/clang/include/clang/Tooling/Core/Replacement.h index 1442beb..5bb1e7f 100644 --- a/clang/include/clang/Tooling/Core/Replacement.h +++ b/clang/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 -- 2.7.4