From: Chandler Carruth <chandlerc@gmail.com>
Date: Sun, 13 Nov 2011 11:34:55 +0000 (+0000)
Subject: Add a missing doxygen comment for a helper method.
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=729bec89bd8c4368a741359fb882967ce01a6909;p=oota-llvm.git

Add a missing doxygen comment for a helper method.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@144497 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/lib/CodeGen/MachineBlockPlacement.cpp b/lib/CodeGen/MachineBlockPlacement.cpp
index 3eb2998116d..ec0877fc055 100644
--- a/lib/CodeGen/MachineBlockPlacement.cpp
+++ b/lib/CodeGen/MachineBlockPlacement.cpp
@@ -275,6 +275,12 @@ static std::string getBlockNum(MachineBasicBlock *BB) {
 }
 #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,