aboutsummaryrefslogtreecommitdiff
path: root/eval.h
diff options
context:
space:
mode:
authorTeddy <ted.sybil@gmail.com>2013-08-04 09:40:43 +0800
committerTeddy <ted.sybil@gmail.com>2013-08-04 09:40:43 +0800
commit9e834528d38a89eb4075b09b35fb7b6e7636740d (patch)
tree5826c2142c69b7c96515262fb4d3e9e6b0ed819c /eval.h
parentc66dc142d240ec2e2ae78201d9614de76535be38 (diff)
added more docs
Diffstat (limited to 'eval.h')
-rw-r--r--eval.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/eval.h b/eval.h
index 0ec08f3..78ede95 100644
--- a/eval.h
+++ b/eval.h
@@ -2,13 +2,16 @@
#define EVAL_H
#include "model.h"
+/** @class Evaluator
+ * A runtime platform of interpreting
+ */
class Evaluator {
private:
- Environment *envt;
- void add_builtin_routines();
+ Environment *envt; /**< Store the current environment */
+ void add_builtin_routines(); /**< Add builtin routines to the env */
public:
Evaluator();
- EvalObj *run_expr(Cons *prog);
+ EvalObj *run_expr(Cons *prog); /**< Interpret a program */
};
#endif