From 3899e498df64aac026cdfc8ab6c8f1d66901dc05 Mon Sep 17 00:00:00 2001
From: Gabor Greif
Date: Fri, 27 Feb 2009 11:37:41 +0000
Subject: [PATCH] update ilist documentation and add some blurb on ilist_node
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@65629 91177308-0d34-0410-b5e6-96231b3b80d8
---
docs/ProgrammersManual.html | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html
index 708211fa7d2..e2918c0438f 100644
--- a/docs/ProgrammersManual.html
+++ b/docs/ProgrammersManual.html
@@ -54,7 +54,7 @@ option
<vector>
<deque>
<list>
- llvm/ADT/ilist
+ llvm/ADT/ilist.h
Other Sequential Container Options
Set-Like Containers (std::set, SmallSet, SetVector, etc)
@@ -878,7 +878,7 @@ not invalidate iterator or pointers to other elements in the list.
@@ -895,6 +895,25 @@ list, and ilists are guaranteed to support a constant-time splice operation.
These properties are exactly what we want for things like Instructions and
basic blocks, which is why these are implemented with ilists.
+
+Related classes of interest are explained in the following subsections:
+
+
+
+
+
+
ilist_node<T> implements a the forward and backward links
+that are expected by the ilist<T> (and analogous containers)
+in the default manner.
+
+
ilist_node<T>s are meant to be embedded in the node type
+T.