Add a comment to the method decl

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

diff --git a/include/llvm/Analysis/DSGraph.h b/include/llvm/Analysis/DSGraph.h
index e9b0272..10dca09 100644 (file)
--- a/include/llvm/Analysis/DSGraph.h
+++ b/include/llvm/Analysis/DSGraph.h
@@ -290,14 +290,18 @@ public:
 
   void AssertGraphOK() const;
 
-  void DSGraph::mergeInGlobalsGraph();
+  /// mergeInGlobalsGraph - This method is useful for clients to incorporate the
+  /// globals graph into the DS, BU or TD graph for a function.  This code
+  /// retains all globals, i.e., does not delete unreachable globals after they
+  /// are inlined.
+  ///
+  void mergeInGlobalsGraph();
 
-public:
-  // removeTriviallyDeadNodes - After the graph has been constructed, this
-  // method removes all unreachable nodes that are created because they got
-  // merged with other nodes in the graph.  This is used as the first step of
-  // removeDeadNodes.
-  //
+  /// removeTriviallyDeadNodes - After the graph has been constructed, this
+  /// method removes all unreachable nodes that are created because they got
+  /// merged with other nodes in the graph.  This is used as the first step of
+  /// removeDeadNodes.
+  ///
   void removeTriviallyDeadNodes();
 };
 

diff --git a/include/llvm/Analysis/DataStructure/DSGraph.h b/include/llvm/Analysis/DataStructure/DSGraph.h
index e9b0272..10dca09 100644 (file)
--- a/include/llvm/Analysis/DataStructure/DSGraph.h
+++ b/include/llvm/Analysis/DataStructure/DSGraph.h
@@ -290,14 +290,18 @@ public:
 
   void AssertGraphOK() const;
 
-  void DSGraph::mergeInGlobalsGraph();
+  /// mergeInGlobalsGraph - This method is useful for clients to incorporate the
+  /// globals graph into the DS, BU or TD graph for a function.  This code
+  /// retains all globals, i.e., does not delete unreachable globals after they
+  /// are inlined.
+  ///
+  void mergeInGlobalsGraph();
 
-public:
-  // removeTriviallyDeadNodes - After the graph has been constructed, this
-  // method removes all unreachable nodes that are created because they got
-  // merged with other nodes in the graph.  This is used as the first step of
-  // removeDeadNodes.
-  //
+  /// removeTriviallyDeadNodes - After the graph has been constructed, this
+  /// method removes all unreachable nodes that are created because they got
+  /// merged with other nodes in the graph.  This is used as the first step of
+  /// removeDeadNodes.
+  ///
   void removeTriviallyDeadNodes();
 };