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

[Chris Lattner]

Author: lattner
Date: Tue Apr  5 18:18:20 2011
New Revision: 128954

URL: http://llvm.org/viewvc/llvm-project?rev=128954&view=rev
Log:
mention llvm::ArrayRef, which should be use much more pervasively than
it already is.


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=128954&r1=128953&r2=128954&view=diff
==============================================================================
--- llvm/trunk/docs/ProgrammersManual.html (original)
+++ llvm/trunk/docs/ProgrammersManual.html Tue Apr  5 18:18:20 2011
@@ -56,6 +56,7 @@
     <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>
@@ -891,6 +892,21 @@
 
 <!-- _______________________________________________________________________ -->
 <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>
 </div>