Changeset 2598 in Sophya for trunk/SophyaLib/SysTools/cexpre.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/cexpre.h (modified) (4 diffs)

trunk/SophyaLib/SysTools/cexpre.h

@@ -14 +14 @@
 namespace SOPHYA {
 
-//! Exception class used by  CExpressionEvaluator
+/*! 
+  \ingroup SysTools
+  \brief Exception class used by  CExpressionEvaluator
+*/
 class CExprException : public PException {
   public:
@@ -22 +25 @@
 
 //--------------------------------------------------------------------
-//! Base class for arithmetic expressions used by CExpressionEvaluator
+/*! 
+  \ingroup SysTools
+  \brief Base class for arithmetic expressions used by CExpressionEvaluator
+  \sa CExpressionEvaluator
+*/
 class CExprBase {
 public:
@@ -39 +46 @@
 };
 
+/*! 
+  \ingroup SysTools
+  \brief For formatted write (print) of expressions in a stream
+*/
 inline ostream& operator << (ostream& s, CExprBase const & ex)
   {  ex.Print(s);  return(s);  }
@@ -45 +56 @@
 class CE_FuncExp;
 //---------------------------------------------------------
-//! Class for evaluation of arithmetic expressions with C-like syntax
 class CExpressionEvaluator : public CExprBase {
 public:
   CExpressionEvaluator(string const & sex);
   virtual ~CExpressionEvaluator();
+//! Evaluate the expression and returns the corresponding value.
   virtual double Evaluate() const;
+//! Alias for Evaluate()
   inline double Value() const { return Evaluate(); }
+//! Formatted output on a stream
   virtual void  Print(ostream& os) const;
 
 protected:
+//! Does the parsing and builds an CExprBase object.
   CExprBase* ParseString(int extype, string fname, string const & sex, 
                     size_t off, size_t& stop, string& errmsg);