[Compbench-devel] CompBenchmarks++/libcompbenchmarks/UI UI-Console.h, 1.2, 1.3

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

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

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

Index: UI-Console.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/UI/UI-Console.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** UI-Console.h	1 Aug 2007 19:48:38 -0000	1.2
--- UI-Console.h	9 Sep 2007 18:21:19 -0000	1.3
***************
*** 21,37 ****
--- 21,72 ----
    {
    private:
+     /** String for current message. */ 
      std::string curmsg;
+     /** 1 if last displayed character is a line feed. */
      int         lastisLF;
+     /** 1 if a line feed may need to be appended next. */
      int         lastprogressmayneedLF;
  
+     /** Display a line feed. */
      virtual void LF(void);
    protected:
+     /** Compute depth of a message.
+      *
+      *  Returns the number of parents of a message
+      *  \param _msg Message instance
+      *  \return Number of parents for given message
+      */
      virtual int depth(UIMsg *_msg);
  
+     /** Get flags from a message.
+      *  \param _msg Message instance
+      *  \return Flags for the given message
+      */
      virtual UIMsg::Flags flags(UIMsg *_msg);
+ 
+     /** Get progress information on a message.
+      *  \param _msg Message instance
+      *  \return Progress (0 to 100.0)
+      */
      virtual float progress(UIMsg *_msg);
+ 
+     /** Get action from a message.
+      *  \param _msg Message instance
+      *  \return Action for the given message
+      */
      virtual UIMsg::ActionType action(UIMsg *_msg);
+ 
+     /** Get a field from a message.
+      *  \param _msg Message instance
+      *  \param _field Field to get
+      *  \return Value of field in message
+      */
      virtual std::string objectField(UIMsg *_msg,
  				    std::string _field);
+ 
+     /** Get message's child number.
+      *  \param _msg Message instance
+      *  \return Child number for given message
+      */
      virtual int childNumber(UIMsg *_msg);
    public: