30.11.2013 - New PICollection namespace, Android support, my own PIVector implementation

pievaluator.h

@@ -122,21 +122,49 @@ private:
 class PIP_EXPORT PIEvaluator
 {
 public:
+	
+	//! Constructs an empty evaluator
 	PIEvaluator() {correct = false;}
+	
 	~PIEvaluator() {;}
 	
+	
+	//! Check mathematical expression and parse it to list of instructions
 	bool check(const PIString & string);
+	
+	//! Returns true if expression was checked succesfully
 	bool isCorrect() const {return correct;}
+	
+	//! Set variable value with name "name" to value "value". Add variable if it doesn`t exists
 	int setVariable(const PIString & name, complexd value = 0.) {if (content.findVariable(name) < 0) content.addVariable(name, value); else content.setVariableValue(name, value); return content.findVariable(name);}
+
+	//! Set variable value with index "index" to value "value". Don`t add variable if it doesn`t exists
 	void setVariable(int index, complexd value = 0.) {if (index >= 0 && index < content.variablesCount()) content.setVariableValue(index, value);}
+
 	void setCustomVariableValue(int index, complexd value = 0.) {content.variables[index + content.cv_count].value = value;}
+
+	//! Evaluate last successfully checked with function \a check() expression and returns result
 	complexd evaluate();
+
+	//! Remove variable with name "name"
 	void removeVariable(const PIString & name) {content.removeVariable(name);}
+
+	//! Remove all manually added variables
 	void clearCustomVariables() {content.clearCustomVariables();}
+
+	//! Returns index of variable with name "name"
 	int variableIndex(const PIString & name) const {return content.findVariable(name);}
+	
+	//! Returns all unknown variables founded in last expression passed to \a check() function
 	const PIStringList & unknownVariables() const {return unknownVars;}
+	
+	//! Returns processed last expression passed to \a check() function
 	const PIString & expression() const {return currentString;}
+	
+	//! Returns last error description occured in \a check() function
 	const PIString & error() const {return lastError;}
+	
+	//! Returns last result of \a evaluate()
 	const complexd & lastResult() const {return out;}
 	
 	PIEvaluatorContent content;