[Compbench-devel] CompBenchmarks++/libcompbenchmarks/Benchmark Benchmark.h, 1.9, 1.10 Package.h, 1.8, 1.9

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

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

Modified Files:
	Benchmark.h Package.h 
Log Message:
For SF's TID #141819 : improving documentation.

Index: Benchmark.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Benchmark/Benchmark.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** Benchmark.h	4 Sep 2007 19:43:54 -0000	1.9
--- Benchmark.h	10 Sep 2007 20:28:12 -0000	1.10
***************
*** 54,58 ****
--- 54,61 ----
      /** Pure virtual method to run benchmark.
       *
+      *  This method is called by Bench().
+      *
       *  \return Benchmark's result (as number).
+      *  \sa Bench()
       */
      virtual std::string bench(void) = 0;
***************
*** 81,84 ****
--- 84,88 ----
       *  \sa Make()
       *  \sa executionTime()
+      *  \sa bench()
       *  \sa status */
      virtual Result *Bench(Compiler *C,

Index: Package.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Benchmark/Package.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** Package.h	4 Sep 2007 19:45:35 -0000	1.8
--- Package.h	10 Sep 2007 20:28:12 -0000	1.9
***************
*** 52,56 ****
     *  This class can be overloaded in order to get new external packages
     *  supported by CompBenchmarks. Basically it sets up packages (like gzip),
!    *  and prepares related benchmarks for evaluation.
     *
     *  \sa Benchmark
--- 52,58 ----
     *  This class can be overloaded in order to get new external packages
     *  supported by CompBenchmarks. Basically it sets up packages (like gzip),
!    *  and prepares related benchmarks for evaluation. Notice that a generic XML
!    *  configured pseudo-package is studied, so that no C++ coding nor changes in
!    *  libcompenchmarks will be necessary to get a package supported.
     *
     *  \sa Benchmark
***************
*** 483,487 ****
       *  This step won't be done and'll return 0 if getStatus()<Package::Made. May changes status.
       *  \return 1 if ok.
!      *  \sa Bench() */
      virtual int         Release(void);
  
--- 485,489 ----
       *  This step won't be done and'll return 0 if getStatus()<Package::Made. May changes status.
       *  \return 1 if ok.
!      */
      virtual int         Release(void);