From: Zhongxing Xu <xuzhongxing@gmail.com>
Date: Fri, 10 Apr 2009 06:52:49 +0000 (+0000)
Subject: update analyzer doc.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=cf665e1fbaf14b5f9e4ec44622eb2053c251edcb;p=clang

update analyzer doc.

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

diff --git a/docs/AnalyzerRegions.html b/docs/AnalyzerRegions.html
index 6767cfd579..992db15225 100644
--- a/docs/AnalyzerRegions.html
+++ b/docs/AnalyzerRegions.html
@@ -107,6 +107,24 @@ char *r = (char*) p;
 <p>Thus we need to canonicalize the MemRegion which is used in binding and
 retrieving.</p>
 
+<h3>Regions</h3>
+<p>Region is the entity used to model pointer values. A Region has the following
+properties:</p>
+
+<ul>
+<li>Kind</li>
+
+<li>ObjectType: the type of the object residing on the region.</li>
+
+<li>LocationType: the type of the pointer value that the region corresponds to.
+  Usually this is the pointer to the ObjectType. But sometimes we want to cache
+  this type explicitly, for example, for a CodeTextRegion.</li>
+
+<li>StartLocation</li>
+
+<li>EndLocation</li>
+</ul>
+
 <h3>Symbolic Regions</h3>
 
 <p>A symbolic region is a map of the concept of symbolic values into the domain