[llvm-commits] [llvm] r144497 - /llvm/trunk/lib/CodeGen/MachineBlockPlacement.cpp

[Chandler Carruth]

Author: chandlerc
Date: Sun Nov 13 05:34:55 2011
New Revision: 144497

URL: http://llvm.org/viewvc/llvm-project?rev=144497&view=rev
Log:
Add a missing doxygen comment for a helper method.

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

Modified: llvm/trunk/lib/CodeGen/MachineBlockPlacement.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/CodeGen/MachineBlockPlacement.cpp?rev=144497&r1=144496&r2=144497&view=diff
==============================================================================
--- llvm/trunk/lib/CodeGen/MachineBlockPlacement.cpp (original)
+++ llvm/trunk/lib/CodeGen/MachineBlockPlacement.cpp Sun Nov 13 05:34:55 2011
@@ -275,6 +275,12 @@
 }
 #endif
 
+/// \brief Mark a chain's successors as having one fewer preds.
+///
+/// When a chain is being merged into the "placed" chain, this routine will
+/// quickly walk the successors of each block in the chain and mark them as
+/// having one fewer active predecessor. It also adds any successors of this
+/// chain which reach the zero-predecessor state to the worklist passed in.
 void MachineBlockPlacement::markChainSuccessors(
     BlockChain &Chain,
     MachineBasicBlock *LoopHeaderBB,