Add comments to the abstract interpreter interface.

Author: martin

src/analyses/ai.h

@@ -25,6 +25,8 @@ Author: Daniel Kroening, [email protected]
 
 #include "ai_domain.h"
 
+/// The basic interface of an abstract interpreter.  This should be enough
+/// to create, run and query an abstract interpreter.
 // don't use me -- I am just a base class
 // use ait instead
 class ai_baset
@@ -41,6 +43,7 @@ class ai_baset
   {
   }
 
+  /// Running the interpretter
   void operator()(
     const goto_programt &goto_program,
     const namespacet &ns)
@@ -100,6 +103,7 @@ class ai_baset
     return abstract_state_before(std::next(l));
   }
 
+  /// Resets the domain
   virtual void clear()
   {
   }
@@ -244,6 +248,9 @@ class ai_baset
     const goto_functionst &goto_functions,
     const namespacet &ns);
 
+  // Visit performs one step of abstract interpretation from history h
+  // Depending on the instruction type it may compute a number of "edges"
+  // or applications of the abstract transformer
   // true = found something new
   bool visit(
     locationt l,