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

trunk/SophyaLib/SysTools/commander.h

@@ -27 +27 @@
 // Classe definissant l'interface pour un interpreteur de commande
 
-//! Interface definition for a generic command interpreter
+/*!
+  \ingroup SysTools
+  \brief  Interface definition for a generic command interpreter.
+*/
 class CmdInterpreter {
 public:
   virtual               ~CmdInterpreter() {} ;
+//! Returns the interpreter's name
   virtual string        Name()=0;
+//! Method to be called in order to interpret a line or string.
   virtual int           Interpret(string& line)=0;
 };
 
 
-//! Interface definition for command executor, to be used with SOPHYA::Commander
+/*!
+  \ingroup SysTools
+  \brief Interface definition for command executor, to be used with Commander
+
+  A command is defined by a keyword and a number of argument
+*/
 
 class CmdExecutor {
@@ -159 +169 @@
 
 // Pour enregistrer la liste de commandes et leurs executeurs et le help
+//! Command executor registration - For Commander internal use
   struct cmdex {int group; string us; CmdExecutor * cex; } ;
+//! Help text registration - For Commander internal use
   struct hgrpst {int gid; string desc; } ;               // Identification+description d'un groupe de help
   typedef map<string, hgrpst, less<string> > CmdHGroup;   // Liste des groupes de commandes