Changeset 2804 in Sophya

Timestamp:

Jun 9, 2005, 5:52:03 PM (20 years ago)

Author:

ansari

Message:

MAJ commentaires documentation pour doxygen - Reza 9 Juin 2005

Location:

trunk/SophyaLib/SysTools

Files:

• cexpre.cc (modified) (1 diff)
• commander.h (modified) (4 diffs)
• psighand.cc (modified) (1 diff)
• rpneval.cc (modified) (2 diffs)

trunk/SophyaLib/SysTools/cexpre.cc

@@ -37 +37 @@
 
 //---------------------------------------------------------
+/*! 
+  \internal 
+  \ingroup SysTools
+  \brief Class representing numbers for expression evaluation 
+  \sa CExpressionEvaluator
+*/
 class CE_NumberExp : public CExprBase {
 public:

trunk/SophyaLib/SysTools/commander.h

@@ -23 +23 @@
 
 namespace SOPHYA {
-// Classe definissant l'interface pour un executeur de commande
-
-// Classe definissant l'interface pour un interpreteur de commande
+
+////// Classe definissant l'interface pour un interpreteur de commande
 
 /*!
@@ -40 +39 @@
 };
 
+
+/////// Classe definissant l'interface pour un executeur de commande
 
 /*!
@@ -181 +182 @@
 
 // Pour enregistrer la liste de commandes et leurs executeurs et le help
-//! Command executor registration - For Commander internal use
+/*! \cond   Pour supprimer la documentation par doxygen */
+//  Command executor registration - For Commander internal use
   struct cmdex {int group; string us; CmdExecutor * cex; } ;
-//! Help text registration - For Commander internal use
+//  Help text registration - For Commander internal use
   struct hgrpst {int gid; string desc; } ;               // Identification+description d'un groupe de help
+  /*! \endcond */
+
   typedef map<string, hgrpst, less<string> > CmdHGroup;   // Liste des groupes de commandes
   CmdHGroup cmdhgrp;
@@ -191 +195 @@
   CmdExmap cmdexmap;                                   // Liste des commandes et leurs executeurs
   CmdExmap helpexmap;                                  // Pour les helps sans commande
-
 // Pour garder la liste des threads d'execution de commande
   list<CommandExeThr *> CmdThrExeList;

trunk/SophyaLib/SysTools/psighand.cc

@@ -18 +18 @@
    Configures signal handling. When the flag is true, an exception 
    \b CaughtSignalExc is thrown with the excpetion id set to the 
-   signal id. With the flag is false, the default signal handling
+   signal id. If the flag is false, the default signal handling
    is restored.
    \param cfpe : Floating point exception \c SIGFPE

trunk/SophyaLib/SysTools/rpneval.cc

@@ -15 +15 @@
   Arithmetic expression (double precision float) evaluator 
   in Reverse Polish Notation (RPN). This is an HP calculator 
-  like syntax. Space are used for separating the string 
+  like syntax. Spaces are used for separating the string 
   expression into tokens. \n
   The string parsed by RPNExpressionEvaluator should be 
@@ -23 +23 @@
   The stack is limited only
   by the available memory. The three numbers on the stack top
-  are referred to as <tt> x y x </tt>. \n
+  are referred to as <tt> x y z </tt>. \n
   Available operations: 
   - op= + - * / % : replace (x,y) by x.op.y