compbench-devel

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

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

Modified Files:
	Benchmark-DLLoader.h Benchmark.h Benchmark-xZIP.h 
Log Message:
For SF's TID #141819 : improving Doxygen documentation.

Index: Benchmark.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Benchmark/Benchmark.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** Benchmark.h	2 Aug 2007 17:06:28 -0000	1.8
--- Benchmark.h	4 Sep 2007 19:43:54 -0000	1.9
***************
*** 35,51 ****
    private:
    protected:
      class Package *package;
  
      /** Constructor
!      *  Initialise the Benchmark::system variable. */
      Benchmark(class Package *_package);
  
      /** Give object for underlaying system.
! 	Use package pointer.
! 	\sa package
      */
      virtual class System *System(void);
  
!     /** Pure virtual method to run benchmark
       *  \return Benchmark's result (as number).
       */
--- 35,57 ----
    private:
    protected:
+     /** Parent package for the benchmark. */
      class Package *package;
  
      /** Constructor
!      *
!      *  Initialise the Benchmark::system variable.
!      *  \param _package Related package.
!      */
      Benchmark(class Package *_package);
  
      /** Give object for underlaying system.
!      *
!      *  Use package instance's pointer.
!      *  \sa package
      */
      virtual class System *System(void);
  
!     /** Pure virtual method to run benchmark.
!      *
       *  \return Benchmark's result (as number).
       */
***************
*** 56,72 ****
  
    public:
!     /** Benchmark name
! 	\return a std::string representing current benchmark's identification
! 	(e.g. gzip-1c) */
      virtual std::string Name(void);
  
!     /** Benchmark comments
! 	\return a std::string containing comments about current benchmark */
      virtual std::string Comments(void) = 0;
    
      /** Run benchmark.
       *  Uses bench(). Overloading is unadvised.
       *  This step won't be done and'll return 1 if getStatus()>=Package::Benchmarked.
!      *  \return benchmark's result (performance) as a non-null positive number in a CBM::Result instance. May changes status.
       *  \sa Make()
       *  \sa executionTime()
--- 62,82 ----
  
    public:
!     /** Benchmark name.
!      *
!      *  \return a std::string representing current benchmark's identification
!      *  (e.g. gzip-1c) */
      virtual std::string Name(void);
  
!     /** Benchmark comments.
!      * 	\return a std::string containing comments about current benchmark */
      virtual std::string Comments(void) = 0;
    
      /** Run benchmark.
+      *
       *  Uses bench(). Overloading is unadvised.
       *  This step won't be done and'll return 1 if getStatus()>=Package::Benchmarked.
!      *  \param C Compiler to use
!      *  \param O Options to use (compilation options)
!      *  \return benchmark's result indicators in a CBM::Result instance. May changes status.
       *  \sa Make()
       *  \sa executionTime()
***************
*** 76,79 ****
--- 86,90 ----
      
      /** Give execution time.
+      *
       *  Returns last execution time (in seconds) of bench().
       *  \return execution time in seconds

Index: Benchmark-DLLoader.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Benchmark/Benchmark-DLLoader.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** Benchmark-DLLoader.h	22 Jan 2007 18:21:47 -0000	1.1
--- Benchmark-DLLoader.h	4 Sep 2007 19:43:54 -0000	1.2
***************
*** 30,51 ****
    /** Low-level internal benchmark's shared library object */
    typedef struct cbmlib_internal {
!     void                            *library;
!     cbmlib_internal_getPackage_t    PackageGet;
    };
  
    /** \brief Low-level library loading according to the benchmark/package's
!       internal name.
!       \param package_id something like gzip, bzip2, nbench and so on.
!   */
    cbmlib_internal *cbmlib_load(char *package_id);
    
    /** \brief Low-level function to Get a CBMBenchmark instance from a
     *   shared library.
     *  \param bench_id gzip-1c, benchpp-whetstone and so on.
!    *  \param _system A system instance.
     */
    Benchmark *cbmlib_bench_load(char *bench_id, System *_system);
    
!   /** \brief Low-level function for removing any internal existing reference to shared libraries. */
    void cbmlib_done(void);
  }
--- 30,57 ----
    /** Low-level internal benchmark's shared library object */
    typedef struct cbmlib_internal {
!     void                          *library;    /*!< Library pointer */
!     cbmlib_internal_getPackage_t  PackageGet;  /*!< Access method */
    };
  
    /** \brief Low-level library loading according to the benchmark/package's
!    *  internal name.
!    *
!    *  \param package_id something like gzip, bzip2, nbench and so on.
!    *  \return A pointer to a library.
!    */
    cbmlib_internal *cbmlib_load(char *package_id);
    
    /** \brief Low-level function to Get a CBMBenchmark instance from a
     *   shared library.
+    *
     *  \param bench_id gzip-1c, benchpp-whetstone and so on.
!    *  \param _system A CBM::System instance.
!    *  \return A benchmark's instance.
     */
    Benchmark *cbmlib_bench_load(char *bench_id, System *_system);
    
!   /** \brief Destroy dynamic library objects.
!    *
!    *   Low-level function for removing any internal existing reference to shared libraries. */
    void cbmlib_done(void);
  }

Index: Benchmark-xZIP.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Benchmark/Benchmark-xZIP.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Benchmark-xZIP.h	16 May 2007 12:07:09 -0000	1.2
--- Benchmark-xZIP.h	4 Sep 2007 19:43:54 -0000	1.3
***************
*** 48,52 ****
     
    public:
!     /** Constructor */
      PackagexZIP(class System *_system);
  
--- 48,53 ----
     
    public:
!     /** Constructor
!      *  \param _system A CBM::System instance. */
      PackagexZIP(class System *_system);
  
***************
*** 67,88 ****
    {
    protected:
      BenchmarkxZIP(CBM::Package *_package);
  
!     /** Compression level
! 	\return compression level ("0" .. "9") used.
!     */
      virtual char* compressionLevel(void) = 0;
  
      /** Program name
! 	\return std::string like gzip or bzip2.
!     */
      virtual std::string benchmarkProgram(void) = 0;
  
  
      /** Runs the benchmark
!      *  Gives the amount of compressed bytes per seconds (as CompBenchmarks always apply
!      *  "bigger is better" policy to benchmarks' results, we can just rely on time). */
  
      virtual std::string bench(void);
      virtual ~BenchmarkxZIP();
    };
--- 68,100 ----
    {
    protected:
+     /** Constructor.
+      *  \param _package Related package.
+      */
      BenchmarkxZIP(CBM::Package *_package);
  
!     /** Compression level.
!      *
!      *  \return compression level ("0" .. "9") used.
!      */
      virtual char* compressionLevel(void) = 0;
  
      /** Program name
!      *  \return std::string like gzip or bzip2.
!      */
      virtual std::string benchmarkProgram(void) = 0;
  
  
      /** Runs the benchmark
!      *
!      *  Gives the amount of compressed bytes per seconds (as CompBenchmarks
!      *  always apply "higher is better" policy to benchmarks' results, we
!      *  can just rely on time).
!      *
!      *  \return Benchmark performance (almost throughput).
!      */
  
      virtual std::string bench(void);
+ 
+     /** Destructor */
      virtual ~BenchmarkxZIP();
    };