[llvm] r277903 - IfConversion: Document countDuplicatedInstructions. NFC

[Kyle Butt via llvm-commits]

Author: iteratee
Date: Fri Aug  5 20:52:33 2016
New Revision: 277903

URL: http://llvm.org/viewvc/llvm-project?rev=277903&view=rev
Log:
IfConversion: Document countDuplicatedInstructions. NFC

Modified:
    llvm/trunk/lib/CodeGen/IfConversion.cpp

Modified: llvm/trunk/lib/CodeGen/IfConversion.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/CodeGen/IfConversion.cpp?rev=277903&r1=277902&r2=277903&view=diff
==============================================================================
--- llvm/trunk/lib/CodeGen/IfConversion.cpp (original)
+++ llvm/trunk/lib/CodeGen/IfConversion.cpp Fri Aug  5 20:52:33 2016
@@ -564,6 +564,18 @@ static inline bool skipDebugInstructions
   return It == Begin;
 }
 
+/// Count duplicated instructions and move the iterators to show where they
+/// are.
+/// @param TIB True Iterator Begin
+/// @param FIB False Iterator Begin
+/// These two iterators initially point to the first instruction of the two
+/// blocks, and finally point to the first non-shared instruction.
+/// @param TIE True Iterator End
+/// @param FIE False Iterator End
+/// These two iterators initially point to End() for the two blocks() and
+/// finally point to the first shared instruction in the tail.
+/// Upon return [TIB, TIE), and [FIB, FIE) mark the un-duplicated portions of
+/// two blocks.
 static void countDuplicatedInstructions(
     MachineBasicBlock::iterator &TIB,
     MachineBasicBlock::iterator &FIB,