[llvm-commits] [llvm] r65629 - /llvm/trunk/docs/ProgrammersManual.html

[Gabor Greif]

Author: ggreif
Date: Fri Feb 27 05:37:41 2009
New Revision: 65629

URL: http://llvm.org/viewvc/llvm-project?rev=65629&view=rev
Log:
update ilist documentation and add some blurb on ilist_node

Modified:
    llvm/trunk/docs/ProgrammersManual.html

Modified: llvm/trunk/docs/ProgrammersManual.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/ProgrammersManual.html?rev=65629&r1=65628&r2=65629&view=diff

==============================================================================
--- llvm/trunk/docs/ProgrammersManual.html (original)
+++ llvm/trunk/docs/ProgrammersManual.html Fri Feb 27 05:37:41 2009
@@ -54,7 +54,7 @@
       <li><a href="#dss_vector"><vector></a></li>
       <li><a href="#dss_deque"><deque></a></li>
       <li><a href="#dss_list"><list></a></li>
-      <li><a href="#dss_ilist">llvm/ADT/ilist</a></li>
+      <li><a href="#dss_ilist">llvm/ADT/ilist.h</a></li>
       <li><a href="#dss_other">Other Sequential Container Options</a></li>
     </ul></li>
     <li><a href="#ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
@@ -878,7 +878,7 @@
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
-  <a name="dss_ilist">llvm/ADT/ilist</a>
+  <a name="dss_ilist">llvm/ADT/ilist.h</a>
 </div>
 
 <div class="doc_text">
@@ -895,6 +895,25 @@
 
 <p>These properties are exactly what we want for things like Instructions and
 basic blocks, which is why these are implemented with ilists.</p>
+
+Related classes of interest are explained in the following subsections:
+    <ul>
+      <li><a href="#dss_ilist_node">llvm/ADT/ilist_node.h</a></li>
+    </ul>
+</div>
+
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
+  <a name="dss_ilist_node">llvm/ADT/ilist_node.h</a>
+</div>
+
+<div class="doc_text">
+<p><tt>ilist_node<T></tt> implements a the forward and backward links
+that are expected by the <tt>ilist<T></tt> (and analogous containers)
+in the default manner.</p>
+
+<p><tt>ilist_node<T></tt>s are meant to be embedded in the node type
+<tt>T</tt>.</p>
 </div>
 
 <!-- _______________________________________________________________________ -->