compbench-devel

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

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

Modified Files:
	Config.h Result.h XML.h 
Log Message:
For SF's TID #141819 : improving Doxygen documentation.

Index: XML.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Base/XML.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** XML.h	6 Jun 2007 16:00:29 -0000	1.8
--- XML.h	4 Sep 2007 19:15:58 -0000	1.9
***************
*** 23,29 ****
    {
    protected:
!     std::string   name;   /*!< Attribute name */
!     std::string   value;  /*!< Attribute value */
!     class XMLNode *parent;
  
    public:
--- 23,29 ----
    {
    protected:
!     std::string   name;     /*!< Attribute name */
!     std::string   value;    /*!< Attribute value */
!     class XMLNode *parent;  /*!< Parent XML node (attribute's holder) */
  
    public:
***************
*** 123,126 ****
--- 123,127 ----
      /** Get a child node according to its index.
       *
+      *  \param _index Index of node to return.
       *  \return A node
       *  \sa nodeNumber() */
***************
*** 129,136 ****
--- 130,140 ----
      /** Get a child node according to its name.
       *
+      *  \param _name Name of node to return.
       *  \return A node
       *  \sa getChild() */
      virtual XMLNode *getNode(std::string _name);
  
+     /** Returns parent's node.
+      *  \return Pointer to parent XML node */
      virtual XMLNode *getParent(void);
  
***************
*** 143,146 ****
--- 147,151 ----
      /** Get an attribute according to its name.
       *
+      *  \param _name Attribute's name
       *  \return An attribute
       *  \sa getAttribute()() */
***************
*** 148,151 ****
--- 153,157 ----
  
      /** Get an attribute according to its index
+      *  \param _index Attribute's index
       *  \return An attribute
       *  \sa attributeNumber() */

Index: Config.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Base/Config.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** Config.h	28 May 2007 18:08:00 -0000	1.10
--- Config.h	4 Sep 2007 19:15:58 -0000	1.11
***************
*** 10,13 ****
--- 10,16 ----
  
  #include <Benchmark/Package.h>
+ #include <Compiler/Compiler.h>
+ #include <Compiler/Compiler-Options.h>
+ 
  #include <System/System.h>
  #include <Base/XML.h>
***************
*** 114,120 ****
       *  time. This prevent re-compilation when performance evaluation on same
       *  compiler/options pairs is asked (e.g. through CBM::Benchmark::Bench().
       *  \param _bid Benchmark's ID
!      *  \param _currrentCompiler Compiler instance
       *  \param _currentOptions Options
       *  \sa contextMatches()
       *  \sa CBM::Compiler
--- 117,125 ----
       *  time. This prevent re-compilation when performance evaluation on same
       *  compiler/options pairs is asked (e.g. through CBM::Benchmark::Bench().
+      *
       *  \param _bid Benchmark's ID
!      *  \param _currentCompiler Compiler instance
       *  \param _currentOptions Options
+      *
       *  \sa contextMatches()
       *  \sa CBM::Compiler
***************
*** 122,127 ****
       *  \sa CBM::Package */
      virtual void setContext(std::string           _bid,
! 			    class Compiler        *_currentCompiler,
! 			    class CompilerOptions *_currentOptions);
  
      /** Retrieve compiler previously used.
--- 127,132 ----
       *  \sa CBM::Package */
      virtual void setContext(std::string           _bid,
! 			    CBM::Compiler         *_currentCompiler,
! 			    CBM::CompilerOptions  *_currentOptions);
  
      /** Retrieve compiler previously used.
***************
*** 145,156 ****
       *  asked to be compilated with same options.
       *  \param _bid Benchmark's ID
!      *  \param _currrentCompiler Compiler instance
       *  \param _currentOptions Options
       *  \return 1 if ok, 0 is context doesn't match.
       *  \sa setContext()
       */
!     virtual int contextMatches(std::string _bid,
! 			       class Compiler        *_currentCompiler,
! 			       class CompilerOptions *_currentOptions);
  
      /** Reset benchmark's context.
--- 150,161 ----
       *  asked to be compilated with same options.
       *  \param _bid Benchmark's ID
!      *  \param _currentCompiler Compiler instance
       *  \param _currentOptions Options
       *  \return 1 if ok, 0 is context doesn't match.
       *  \sa setContext()
       */
!     virtual int contextMatches(std::string          _bid,
! 			       CBM::Compiler        *_currentCompiler,
! 			       CBM::CompilerOptions *_currentOptions);
  
      /** Reset benchmark's context.
***************
*** 166,170 ****
       *  Many default/user set paths are used to store packages, uncompress or compile
       *  them and so on. This method retrieves them.
!      *  \parma dir Directory/Path ID
       *  \return Path as std::string */
      virtual std::string Path(CBM::System::Dir dir);
--- 171,175 ----
       *  Many default/user set paths are used to store packages, uncompress or compile
       *  them and so on. This method retrieves them.
!      *  \param dir Directory/Path ID
       *  \return Path as std::string */
      virtual std::string Path(CBM::System::Dir dir);

Index: Result.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Base/Result.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** Result.h	4 Sep 2007 17:06:15 -0000	1.3
--- Result.h	4 Sep 2007 19:15:58 -0000	1.4
***************
*** 32,35 ****
--- 32,41 ----
       *  Constructor mainly builts the associated (internal) XML node with given
       *  values.
+      *
+      *  \param _value benchmark's (performance) value
+      *  \param _compilationTime Compilation time (for package, in ms)
+      *  \param _executionTime Execution time (for benchmark, in ms)
+      *  \param _tested 1 if package can be tested, 0 otherwise
+      *  \param _testOk 1 if package has been tested, 0 otherwise
       */
      Result(std::string _value,
***************
*** 40,43 ****
--- 46,51 ----
  
      /** Create a result object from an XML node.
+      *
+      *  \param _node XML node containing a valid result description.
       */
      Result(XMLNode *_node);