Added more comments to tooling::Replacements.

Summary: Also test phabricator commit processing.

Subscribers: klimek, cfe-commits

Differential Revision: https://reviews.llvm.org/D25207

llvm-svn: 283135
This commit is contained in:
Eric Liu 2016-10-03 19:14:30 +00:00
parent 92abc7e9f2
commit 385f10152c
1 changed files with 4 additions and 0 deletions

View File

@ -176,6 +176,8 @@ class Replacements {
/// - are insertions at the same offset and applying them in either order /// - are insertions at the same offset and applying them in either order
/// has the same effect, i.e. X + Y = Y + X when inserting X and Y /// has the same effect, i.e. X + Y = Y + X when inserting X and Y
/// respectively. /// respectively.
/// - are identical replacements, i.e. applying the same replacement twice
/// is equivalent to applying it once.
/// Examples: /// Examples:
/// 1. Replacement A(0, 0, "a") and B(0, 0, "aa") are order-independent since /// 1. Replacement A(0, 0, "a") and B(0, 0, "aa") are order-independent since
/// applying them in either order gives replacement (0, 0, "aaa"). /// applying them in either order gives replacement (0, 0, "aaa").
@ -186,6 +188,8 @@ class Replacements {
/// since applying them in either order gives (0, 2, "123"). /// since applying them in either order gives (0, 2, "123").
/// 3. Replacement A(0, 3, "123") and B(2, 3, "321") are order-independent /// 3. Replacement A(0, 3, "123") and B(2, 3, "321") are order-independent
/// since either order gives (0, 5, "12321"). /// since either order gives (0, 5, "12321").
/// 4. Replacement A(0, 3, "ab") and B(0, 3, "ab") are order-independent since
/// applying the same replacement twice is equivalent to applying it once.
/// Replacements with offset UINT_MAX are special - we do not detect conflicts /// Replacements with offset UINT_MAX are special - we do not detect conflicts
/// for such replacements since users may add them intentionally as a special /// for such replacements since users may add them intentionally as a special
/// category of replacements. /// category of replacements.