summaryrefslogtreecommitdiffstats
path: root/src/eval_env.h
diff options
context:
space:
mode:
authorEvan Martin <martine@danga.com>2011-04-29 18:03:03 (GMT)
committerEvan Martin <martine@danga.com>2011-04-29 18:04:12 (GMT)
commite3168e1d282d6dcac73f710c5deb575613c335b7 (patch)
tree82b8a12cf35a756ff9f32d5d708e2973f256deb7 /src/eval_env.h
parentfb7c7827ed22662d7dacc0c7a2dd0d48dc41ee06 (diff)
downloadNinja-e3168e1d282d6dcac73f710c5deb575613c335b7.zip
Ninja-e3168e1d282d6dcac73f710c5deb575613c335b7.tar.gz
Ninja-e3168e1d282d6dcac73f710c5deb575613c335b7.tar.bz2
add doxygen-compatibile comments to most classes
Diffstat (limited to 'src/eval_env.h')
-rw-r--r--src/eval_env.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/eval_env.h b/src/eval_env.h
index f0108ae..b1b63ca 100644
--- a/src/eval_env.h
+++ b/src/eval_env.h
@@ -20,13 +20,13 @@
#include <vector>
using namespace std;
-// A scope for variable lookups.
+/// An interface for a scope for variable (e.g. "$foo") lookups.
struct Env {
virtual string LookupVariable(const string& var) = 0;
};
-// A standard scope, which contains a mapping of variables to values
-// as well as a pointer to a parent scope.
+/// An Env which contains a mapping of variables to values
+/// as well as a pointer to a parent scope.
struct BindingEnv : public Env {
BindingEnv() : parent_(NULL) {}
virtual string LookupVariable(const string& var);
@@ -36,8 +36,8 @@ struct BindingEnv : public Env {
Env* parent_;
};
-// A tokenized string that contains variable references.
-// Can be evaluated relative to an Env.
+/// A tokenized string that contains variable references.
+/// Can be evaluated relative to an Env.
struct EvalString {
bool Parse(const string& input, string* err, size_t* err_index=NULL);
string Evaluate(Env* env) const;