[llvm] r209467 - Update some AliasAnalysis pass docs for getAdjustedAnalysisPointer.

[Eric Christopher]

Author: echristo
Date: Thu May 22 14:38:25 2014
New Revision: 209467

URL: http://llvm.org/viewvc/llvm-project?rev=209467&view=rev
Log:
Update some AliasAnalysis pass docs for getAdjustedAnalysisPointer.

Patch by George Burgess.

Modified:
    llvm/trunk/docs/AliasAnalysis.rst

Modified: llvm/trunk/docs/AliasAnalysis.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/AliasAnalysis.rst?rev=209467&r1=209466&r2=209467&view=diff
==============================================================================
--- llvm/trunk/docs/AliasAnalysis.rst (original)
+++ llvm/trunk/docs/AliasAnalysis.rst Thu May 22 14:38:25 2014
@@ -246,6 +246,20 @@ analysis run method (``run`` for a ``Pas
     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
 ---------------------------------