Skip to content

Commit 918e947

Browse files
author
martin
committed
Expand the comments describing the base domain interface.
1 parent f60027b commit 918e947

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/analyses/ai_domain.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,17 @@ Author: Daniel Kroening, [email protected]
1919

2020
#include <goto-programs/goto_model.h>
2121

22-
// forward reference
22+
// forward reference the abstract interpreter interface
2323
class ai_baset;
2424

25+
/// The interface offered by a domain, allows code to manipulate domains without
26+
/// knowing their exact type.
2527
// don't use me -- I am just a base class
2628
// please derive from me
2729
class ai_domain_baset
2830
{
2931
public:
30-
// The constructor is expected to produce 'false'
31-
// or 'bottom'
32+
// The constructor is expected to produce 'false' or 'bottom'
3233
ai_domain_baset()
3334
{
3435
}
@@ -101,6 +102,7 @@ class ai_domain_baset
101102
// PRECONDITION(from.is_dereferenceable(), "Must not be _::end()")
102103
// PRECONDITION(to.is_dereferenceable(), "Must not be _::end()")
103104

105+
104106
// This method allows an expression to be simplified / evaluated using the
105107
// current state. It is used to evaluate assertions and in program
106108
// simplification

0 commit comments

Comments
 (0)