[Compbench-devel] CompBenchmarks++/libcompbenchmarks/UI UI.h, 1.14, 1.15 UI-Msg.h, 1.7, 1.8

[Frederic T. <xf...@us...>]

Update of /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/UI
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv10350

Modified Files:
	UI.h UI-Msg.h 
Log Message:
For SF's TID #141819 : improving Doxygen documentation.

Index: UI.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/UI/UI.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -d -r1.14 -r1.15
*** UI.h	24 Aug 2007 21:52:21 -0000	1.14
--- UI.h	6 Sep 2007 17:12:35 -0000	1.15
***************
*** 45,48 ****
--- 45,50 ----
       *  Finally, it calls Display to report message to user interface.
       *
+      *  \param _msg message to be posted
+      *
       *  \sa mui
       *  \sa current
***************
*** 117,122 ****
      virtual UIMsg *Progress(float _pc);
  
!     /** Call childDone() */
      virtual UIMsg *outputOK(std::string _test = "");
      virtual UIMsg *outputKO(std::string _test = "");
  
--- 119,132 ----
      virtual UIMsg *Progress(float _pc);
  
!     /** Set current message's output to OK.
!      *  \param _test More detailed information
!      *  \return Pointer on current message
!      */
      virtual UIMsg *outputOK(std::string _test = "");
+ 
+     /** Set current message's output to KO.
+      *  \param _test More detailed information
+      *  \return Pointer on current message
+      */
      virtual UIMsg *outputKO(std::string _test = "");
  

Index: UI-Msg.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/UI/UI-Msg.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** UI-Msg.h	21 Aug 2007 19:52:50 -0000	1.7
--- UI-Msg.h	6 Sep 2007 17:12:35 -0000	1.8
***************
*** 12,66 ****
  #include <Base/XML.h>
  
- /*
-   <msg timestamp="..." flags="[No]Progress>
-    <object type="4" name="file.tar.gz"/>
-    <action type="4"/>
-    <output>
-      <text status="info">Blah</text>
-      <text status="ok"/>
-    </output>
-    <progress [value="4"]>
-    <childs/>
-   </msg>
-  */
  namespace CBM {
    class UIMsg : public XMLNode {
    public:
  
      typedef enum Flags {
!       NoProgress,
!       Progress
      };
  
      typedef enum Status {
!       KO, OK, Info
      };
  
      typedef enum ObjectType {
!       UndefObject,
!       Shell, File, Directory, Package, Benchmark, Compiler
      };
  
      typedef enum ActionType {
!       UndefAction,
!       ShellCommand,
!       FatalError,
!       Group,
!       Create, Read, Write, Remove, Checksum,
!       PackageInstall, PackageUninstall,
!       PackageFetch,
!       PackageDownload, PackageExtract, PackagePatch, PackagePreconfigure,
!       PackageConfigure,
!       PackageMake, PackageTest, PackageClean,
!       BenchmarkBench, BenchmarkResult,
!       CompilerAutodetect,
!       PlanRegister, PlanRestore, PlanUnregister,
!       PlanBatchRegister, PlanBatchUnregister,
!       PlanCompilerRegister, PlanCompilerUnregister,
!       PlanOptionsetRegister, PlanOptionsetUnregister,
!       PlanOptionsRegister, PlanOptionsUnregister,
!       PlanOptionRegister, PlanOptionUnregister,
!       PlanBenchmarkRegister, PlanBenchmarkUnregister,
!       PlanRun
      };
  
--- 12,94 ----
  #include <Base/XML.h>
  
  namespace CBM {
+   /** \brief Basic message
+    *
+    *  Define a (UI) message based on XML.
+    */
+ 
    class UIMsg : public XMLNode {
    public:
  
+     /** Flags for message */
      typedef enum Flags {
!       NoProgress, /*!< Standard message */
!       Progress    /*!< Message with progress (percentage) information associated */
      };
  
+     /** Message (output) status */
      typedef enum Status {
!       KO,   /*!< Message (associated action) ended correctly */
!       OK,   /*!< Message (associated action) terminated with an error */
!       Info  /*!< Informative text appended to output. Message is not "closed" */
      };
  
+     /** Object types for message's actors */
      typedef enum ObjectType {
!       UndefObject,  /*!< Not specified actor */
!       Shell,        /*!< Message concerns a shell command */
!       File,         /*!< Message concerns a file */
!       Directory,    /*!< Message concerns a directory */
!       Package,      /*!< Message concerns a package */
!       Benchmark,    /*!< Message concerns a benchmark */
!       Compiler      /*!< Message concerns a compiler */
      };
  
+     /** Action described by message */
      typedef enum ActionType {
!       UndefAction,             /*<! Undefined action */
!       ShellCommand,            /*<! Action is a shell command */
!       FatalError,              /*<! Fatal error occured */
!       Group,                   /*<! Defines a group of actions */
! 
!       Create,                  /*<! Object is being created */
!       Read,                    /*<! Object is being read */
!       Write,                   /*<! Object is being wrote */
!       Remove,                  /*<! Object is being removed */
!       Checksum,                /*<! Object (file) is being checksumed */
! 
!       PackageInstall,          /*<! Package installation */
!       PackageUninstall,        /*<! Package removing */
!       PackageFetch,            /*<! Package is being fetched */
!       PackageDownload,         /*<! Package is being downloaded */
!       PackageExtract,          /*<! Package is being extracted */
!       PackagePatch,            /*<! Package is being fetched */
!       PackagePreconfigure,     /*<! Package is being pre-configured */
!       PackageConfigure,        /*<! Package is being configured */
!       PackageMake,             /*<! Package is being built */
!       PackageTest,             /*<! Package is being tested */
!       PackageClean,            /*<! Package is being cleaned */
!  
!       BenchmarkBench,          /*<! Benchmark is being evaluated */
!       BenchmarkResult,         /*<! Benchmark result */
! 
!       CompilerAutodetect,      /*<! Compiler auto-detection asked */
! 
!       PlanRegister,            /*<! Plan is being registered */
!       PlanRestore,             /*<! Plan is being restored (from file) */
!       PlanUnregister,          /*<! Plan is being unregistered */
!       PlanBatchRegister,       /*<! Batch is being registered */
!       PlanBatchUnregister,     /*<! Batch is being unregistered */
!       PlanCompilerRegister,    /*<! Compiler is being registered */
!       PlanCompilerUnregister,  /*<! Compiler is being unregistered */
!       PlanOptionsetRegister,   /*<! Option set is being registered */
!       PlanOptionsetUnregister, /*<! Option set is being unregistered */
!       PlanOptionsRegister,     /*<! Options are being registered */
!       PlanOptionsUnregister,   /*<! Options are being unregistered */
!       PlanOptionRegister,      /*<! Option is being registered */
!       PlanOptionUnregister,    /*<! Option is being unregistered */
!       PlanBenchmarkRegister,   /*<! Benchmark is being registered */
!       PlanBenchmarkUnregister, /*<! Benchmark is being unregistered */
!       PlanRun                  /*<! Plan is being ran */
      };