From a76507fdc3f2da246165ffde8ee96fd88f1b59b0 Mon Sep 17 00:00:00 2001
From: Chris Lattner <sabre@nondot.org>
Date: Tue, 5 Apr 2011 23:18:20 +0000
Subject: mention llvm::ArrayRef, which should be use much more pervasively
 than it already is.

llvm-svn: 128954
---
 llvm/docs/ProgrammersManual.html | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'llvm/docs/ProgrammersManual.html')

diff --git a/llvm/docs/ProgrammersManual.html b/llvm/docs/ProgrammersManual.html
index a280144eb61..c46f596faff 100644
--- a/llvm/docs/ProgrammersManual.html
+++ b/llvm/docs/ProgrammersManual.html
@@ -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>
-- 
cgit v1.2.3