From: Xin Tong <trent.xin.tong@gmail.com>
Date: Sat, 24 Jun 2017 05:16:12 +0000 (+0000)
Subject: Add comments for OrderedInstruction. NFC
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=718bab77befcbdff9542ecc7c9f287b38836a451;p=llvm

Add comments for OrderedInstruction. NFC

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@306201 cdac9f57-aa62-4fd3-8940-286f4534e8a0
---

diff --git a/include/llvm/Transforms/Utils/OrderedInstructions.h b/include/llvm/Transforms/Utils/OrderedInstructions.h
index e043ff39a99..64c6bcb68b1 100644
--- a/include/llvm/Transforms/Utils/OrderedInstructions.h
+++ b/include/llvm/Transforms/Utils/OrderedInstructions.h
@@ -43,6 +43,9 @@ public:
   bool dominates(const Instruction *, const Instruction *) const;
 
   /// Invalidate the OrderedBasicBlock cache when its basic block changes.
+  /// i.e. If an instruction is deleted or added to the basic block, the user
+  /// should call this function to invalidate the OrderedBasicBlock cache for
+  /// this basic block.
   void invalidateBlock(BasicBlock *BB) { OBBMap.erase(BB); }
 };