summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEric Christopher <echristo@gmail.com>2014-05-22 19:38:25 +0000
committerEric Christopher <echristo@gmail.com>2014-05-22 19:38:25 +0000
commitff93350aa69cc7fa4ade346e550eef51fff46ceb (patch)
tree8fb8516cfd7d4e52554c6b6e4945ed835de7b158 /docs
parentfed4bab1480554965abfd2beaee9ddd38e65c84d (diff)
downloadllvm-ff93350aa69cc7fa4ade346e550eef51fff46ceb.tar.gz
llvm-ff93350aa69cc7fa4ade346e550eef51fff46ceb.tar.bz2
llvm-ff93350aa69cc7fa4ade346e550eef51fff46ceb.tar.xz
Update some AliasAnalysis pass docs for getAdjustedAnalysisPointer.
Patch by George Burgess. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@209467 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/AliasAnalysis.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/AliasAnalysis.rst b/docs/AliasAnalysis.rst
index 3bfb0953af..1cbaee703f 100644
--- a/docs/AliasAnalysis.rst
+++ b/docs/AliasAnalysis.rst
@@ -246,6 +246,20 @@ analysis run method (``run`` for a ``Pass``, ``runOnFunction`` for a
return false;
}
+Required methods to override
+----------------------------
+
+You must override the ``getAdjustedAnalysisPointer`` method on all subclasses
+of ``AliasAnalysis``. An example implementation of this method would look like:
+
+.. code-block:: c++
+
+ void *getAdjustedAnalysisPointer(const void* ID) override {
+ if (ID == &AliasAnalysis::ID)
+ return (AliasAnalysis*)this;
+ return this;
+ }
+
Interfaces which may be specified
---------------------------------