mention llvm::ArrayRef, which should be use much more pervasively than
authorChris Lattner <sabre@nondot.org>
Tue, 5 Apr 2011 23:18:20 +0000 (23:18 +0000)
committerChris Lattner <sabre@nondot.org>
Tue, 5 Apr 2011 23:18:20 +0000 (23:18 +0000)
it already is.

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

docs/ProgrammersManual.html

index a280144eb61547b23fe8825169ea3c95a0010fb9..c46f596faff79e1ce2119e7804c08456b257442d 100644 (file)
@@ -56,6 +56,7 @@ option</a></li>
     <ul>
     <li><a href="#ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
     <ul>
+      <li><a href="#dss_arrayref">llvm/ADT/ArrayRef.h</a></li>
       <li><a href="#dss_fixedarrays">Fixed Size Arrays</a></li>
       <li><a href="#dss_heaparrays">Heap Allocated Arrays</a></li>
       <li><a href="#dss_smallvector">"llvm/ADT/SmallVector.h"</a></li>
@@ -889,6 +890,21 @@ There are a variety of sequential containers available for you, based on your
 needs.  Pick the first in this section that will do what you want.
 </div>
 
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
+  <a name="dss_arrayref">llvm/ADT/ArrayRef.h</a>
+</div>
+
+<div class="doc_text">
+<p>The llvm::ArrayRef class is the preferred class to use in an interface that
+   accepts a sequential list of elements in memory and just reads from them.  By
+   taking an ArrayRef, the API can be passed a fixed size array, an std::vector,
+   an llvm::SmallVector and anything else that is contiguous in memory.
+</p>
+</div>
+
+
+  
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
   <a name="dss_fixedarrays">Fixed Size Arrays</a>