From c81dea107270bb88934b2a4c53b7ffbffe3604fc Mon Sep 17 00:00:00 2001 From: Daniel Berlin Date: Wed, 22 Jun 2016 20:31:12 +0000 Subject: [PATCH] Update header documentation for API deliberately made public git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@273473 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Support/GenericDomTree.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/llvm/Support/GenericDomTree.h b/include/llvm/Support/GenericDomTree.h index 6b65ff8205e..a74f31d5f18 100644 --- a/include/llvm/Support/GenericDomTree.h +++ b/include/llvm/Support/GenericDomTree.h @@ -138,8 +138,9 @@ public: } } - /// getDFSNumIn/getDFSNumOut - These are an internal implementation detail, do - /// not call them. + /// getDFSNumIn/getDFSNumOut - These return the DFS visitation order for nodes + /// in the dominator tree. They are only guaranteed valid if + /// updateDFSNumbers() has been called. unsigned getDFSNumIn() const { return DFSNumIn; } unsigned getDFSNumOut() const { return DFSNumOut; } -- 2.50.1