Changeset 2598 in Sophya for trunk/SophyaLib/SysTools/rpneval.h

Timestamp:

Aug 11, 2004, 3:10:25 PM (21 years ago)

Author:

ansari

Message:

Documentation (ajoutee ou completee) pour les classes du module SysTools - Reza 11 Aout 2004

File:

• trunk/SophyaLib/SysTools/rpneval.h (modified) (2 diffs)

trunk/SophyaLib/SysTools/rpneval.h

@@ -15 +15 @@
 namespace SOPHYA {
 
-//! Exception class used by  RPNExpressionEvaluator
-
+/*!
+  \ingroup SysTools
+  \brief Exception class used by  RPNExpressionEvaluator
+  \sa RPNExpressionEvaluator
+*/
 class RPNExprException : public PException {
   public:
@@ -30 +33 @@
   explicit RPNExpressionEvaluator(vector<string> & exe, int off=0);
   virtual ~RPNExpressionEvaluator();
+//! Return the stack top \c (x) as the result of the expression evaluation
   virtual double Evaluate() const;  // Return the value of the stack top
+//! Alias for Evaluate()
   inline double Value() const { return Evaluate(); }
 
-protected:
+private:
   int EvalRPNExpr(vector<string> & args, int off=0);
   inline bool CheckStack(double& x) const