[Compbench-devel] CompBenchmarks++/libcompbenchmarks/UI UI.h, 1.15, 1.16

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

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

Modified Files:
	UI.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.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** UI.h	6 Sep 2007 17:12:35 -0000	1.15
--- UI.h	6 Sep 2007 17:38:36 -0000	1.16
***************
*** 74,120 ****
      virtual UIMsg *msgFatal(std::string _text);
  
!     /** \brief Emit a shell command execution information
       *
       *  \param _shellCommand Shell command to be executed.
       */
      virtual UIMsg *msgShell(std::string _shellCommand);
      virtual UIMsg *msgCreate(UIMsg::ObjectType _type,
  			     std::string _name);
      virtual UIMsg *msgDownload(std::string _url);
      virtual UIMsg *msgChecksum(std::string _file);
      virtual UIMsg *msgExtract(std::string _name);
      virtual UIMsg *msgPatch(std::string _name);
      virtual UIMsg *msgPreconfigure(std::string _name);
      virtual UIMsg *msgConfigure(std::string _info);
      virtual UIMsg *msgMake(std::string _name);
      virtual UIMsg *msgTest(std::string _name);
      virtual UIMsg *msgRelease(std::string _name);
      virtual UIMsg *msgInstall(std::string _name);
      virtual UIMsg *msgFetch(std::string _name);
      virtual UIMsg *msgUninstall(std::string _name);
      virtual UIMsg *msgBench(std::string _name);
      virtual UIMsg *msgGroup(std::string _name);
  
      virtual UIMsg *msgPlanRegister(std::string _file,
  				   int         _default);
      virtual UIMsg *msgPlanRestore(std::string _name);
      virtual UIMsg *msgPlanUnregister(std::string _name);
      virtual UIMsg *msgPlanBatchRegister(std::string _name);
      virtual UIMsg *msgPlanBatchUnregister(std::string _name);
      virtual UIMsg *msgPlanCompilerRegister(std::string _name);
      virtual UIMsg *msgPlanCompilerUnregister(std::string _name);
      virtual UIMsg *msgPlanOptionsetRegister(std::string _name);
      virtual UIMsg *msgPlanOptionsetUnregister(std::string _name);
      virtual UIMsg *msgPlanOptionsRegister(std::string _name);
      virtual UIMsg *msgPlanOptionsUnregister(std::string _name);
      virtual UIMsg *msgPlanOptionRegister(std::string _name);
      virtual UIMsg *msgPlanOptionUnregister(std::string _name);
      virtual UIMsg *msgPlanBenchmarkRegister(std::string _name);
      virtual UIMsg *msgPlanBenchmarkUnregister(std::string _name);
      virtual UIMsg *msgPlanRun(std::string _name);
  
      virtual UIMsg *outputInfo(std::string _text);
      virtual UIMsg *outputInfo(CBM::Result *_r);
  
      virtual UIMsg *Progress(float _pc);
  
--- 74,324 ----
      virtual UIMsg *msgFatal(std::string _text);
  
!     /** Emit a shell command execution information
       *
       *  \param _shellCommand Shell command to be executed.
+      *  \return Created message
       */
      virtual UIMsg *msgShell(std::string _shellCommand);
+ 
+     /** Emit a object creation message
+      *
+      *  \param _type Object type
+      *  \param _name Created object name
+      *  \return Created message
+      */
      virtual UIMsg *msgCreate(UIMsg::ObjectType _type,
  			     std::string _name);
+ 
+     /** Emit a download message
+      *
+      *  \param _url URL to be downloaded
+      *  \return Created message
+      */
      virtual UIMsg *msgDownload(std::string _url);
+ 
+     /** Emit a checksum message
+      *
+      *  \param _file File to be checksumed
+      *  \return Created message
+      */
      virtual UIMsg *msgChecksum(std::string _file);
+ 
+     /** Emit an object extraction message
+      *
+      *  \param _name Object (file) to be extracted
+      *  \return Created message
+      */
      virtual UIMsg *msgExtract(std::string _name);
+ 
+     /** Emit a patch message
+      *
+      *  \param _name Object (file) to be patched
+      *  \return Created message
+      */
      virtual UIMsg *msgPatch(std::string _name);
+ 
+     /** Emit a preconfiguration message
+      *
+      *  \param _name Package to be preconfigured
+      *  \return Created message
+      */
      virtual UIMsg *msgPreconfigure(std::string _name);
+ 
+     /** Emit a configuration message
+      *
+      *  \param _info Package to be configured
+      *  \return Created message
+      */
      virtual UIMsg *msgConfigure(std::string _info);
+ 
+     /** Emit a build message
+      *
+      *  \param _name Package to be built
+      *  \return Created message
+      */
      virtual UIMsg *msgMake(std::string _name);
+ 
+     /** Emit a testing message
+      *
+      *  \param _name Package to be tested
+      *  \return Created message
+      */
      virtual UIMsg *msgTest(std::string _name);
+ 
+     /** Emit a releasing message
+      *
+      *  \param _name Package to be released
+      *  \return Created message
+      */
      virtual UIMsg *msgRelease(std::string _name);
+ 
+     /** Emit an installation message
+      *
+      *  \param _name Package to be installed
+      *  \return Created message
+      */
      virtual UIMsg *msgInstall(std::string _name);
+ 
+     /** Emit an fetch message
+      *
+      *  \param _name Package to be fetched
+      *  \return Created message
+      */
      virtual UIMsg *msgFetch(std::string _name);
+ 
+     /** Emit an uninstallation message
+      *
+      *  \param _name Package to be uninstalled
+      *  \return Created message
+      */
      virtual UIMsg *msgUninstall(std::string _name);
+ 
+     /** Emit an benchmarking message
+      *
+      *  \param _name Benchmark to be evaluated
+      *  \return Created message
+      */
      virtual UIMsg *msgBench(std::string _name);
+ 
+     /** Emit a group message
+      *
+      *  This allows grouping some child messages together (at a same
+      *  depth).
+      *  \param _name Group's name
+      *  \return Created message
+      */
      virtual UIMsg *msgGroup(std::string _name);
  
+     /** Emit a plan registration message
+      *
+      *  \param _file Plan file to be registered
+      *  \param _default Whether the plan is to be the default or not
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanRegister(std::string _file,
  				   int         _default);
+ 
+     /** Emit a plan restoration message
+      *
+      *  \param _name Plan file to be read
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanRestore(std::string _name);
+ 
+     /** Emit a plan unregistration message
+      *
+      *  \param _name Plan file to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanUnregister(std::string _name);
+ 
+     /** Emit a batch registration message
+      *
+      *  \param _name Batch to be registered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanBatchRegister(std::string _name);
+ 
+     /** Emit a batch unregistration message
+      *
+      *  \param _name Batch to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanBatchUnregister(std::string _name);
+ 
+     /** Emit a compiler registration message
+      *
+      *  \param _name Compiler to be registered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanCompilerRegister(std::string _name);
+ 
+     /** Emit a compiler unregistration message
+      *
+      *  \param _name Compiler to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanCompilerUnregister(std::string _name);
+ 
+     /** Emit an option set registration message
+      *
+      *  \param _name Option set to be registered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanOptionsetRegister(std::string _name);
+ 
+     /** Emit an option set unregistration message
+      *
+      *  \param _name Option set to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanOptionsetUnregister(std::string _name);
+ 
+     /** Emit a registration message for a set of options
+      *
+      *  \param _name Options to be registered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanOptionsRegister(std::string _name);
+ 
+     /** Emit an unregistration message for a set of options
+      *
+      *  \param _name Options to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanOptionsUnregister(std::string _name);
+ 
+     /** Emit an option registration message
+      *
+      *  \param _name Option to be registered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanOptionRegister(std::string _name);
+ 
+     /** Emit an option unregistration message.
+      *
+      *  \param _name Option to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanOptionUnregister(std::string _name);
+ 
+     /** Emit a benchmark registration message.
+      *
+      *  \param _name Benchmark to be registered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanBenchmarkRegister(std::string _name);
+ 
+     /** Emit a benchmark unregistration message.
+      *
+      *  \param _name Benchmark to be unregistered
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanBenchmarkUnregister(std::string _name);
+ 
+     /** Emit a running message for a plan evaluation.
+      *
+      *  \param _name Plan to be ran
+      *  \return Created message
+      */
      virtual UIMsg *msgPlanRun(std::string _name);
  
+     /** Append text to current message's output
+      *  \param _text Text to append
+      *  \return Pointer on current message
+      */
      virtual UIMsg *outputInfo(std::string _text);
+ 
+     /** Append a benchmark's result to current message's output
+      *  \param _r Result to be appended.
+      *  \return Pointer on current message
+      */
      virtual UIMsg *outputInfo(CBM::Result *_r);
  
+     /** Update current progress for a message.
+      *  \param _pc Progress percent (from 0 to 100.0)
+      *  \return Pointer on current message
+      *  \sa Flags
+      */
      virtual UIMsg *Progress(float _pc);
  
***************
*** 131,136 ****
--- 335,351 ----
      virtual UIMsg *outputKO(std::string _test = "");
  
+     /** UI end method to display a message.
+      *  \param _msg Message to display
+      */
      virtual void Display(UIMsg *_msg) = 0;
+ 
+     /** UI end method to display advancement on a message
+      *  \param _msg Concerned message
+      */
      virtual void DisplayProgressUpdate(UIMsg *_msg) = 0;
+ 
+     /** UI end method to close a message
+      *  \param _msg Concerned message (0, default, is current)
+      */
      virtual void DisplayDone(UIMsg *_msg) = 0;