[Compbench-devel] CompBenchmarks++/System System.h,1.18,1.19

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

Update of /cvsroot/compbench/CompBenchmarks++/System
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv31440

Modified Files:
	System.h 
Log Message:
Updated doxygen documentation.

Index: System.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/System/System.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** System.h	15 Jan 2007 17:39:32 -0000	1.18
--- System.h	15 Jan 2007 17:50:13 -0000	1.19
***************
*** 132,145 ****
    /** Give a list containing the compatible benchmarks
     *  in declared directories.
!    *  \return a std::string list of benchmarks (id) */
    virtual PackageVector& packageList(int _force = 0);
  
    virtual int packageNumber(void);
    virtual class CBMPackage *Package(int index);
  
    virtual class CBMPackage *Package(std::string pid);
    virtual class CBMBenchmark *Benchmark(std::string bid);
  
    virtual void displayAllPackages(void);
    virtual void displayAllBenchmarks(void);
  
--- 132,168 ----
    /** Give a list containing the compatible benchmarks
     *  in declared directories.
!    *  \return a std::string list of benchmarks (id)
!    *  \sa Package() */
    virtual PackageVector& packageList(int _force = 0);
  
+   /** Get supported packages' number
+    *  \return integer
+    *  \sa Package() */
    virtual int packageNumber(void);
+ 
+   /** Get a package according to its index
+    *  \return CBMPackage instance
+    *  \sa packageNumber()
+    */
    virtual class CBMPackage *Package(int index);
  
+   /** Get a package acoording to its internal identifier
+    *  \param std::string containing the package's identifier
+    *  \return CBMPackage instance
+    *  \sa packageList()
+    */
    virtual class CBMPackage *Package(std::string pid);
+ 
+   /** Get a benchmark according to its internal identifier
+    *  \param bid std:string containing the benchmark's identifier
+    *  \return CBMBenchmark instance */
    virtual class CBMBenchmark *Benchmark(std::string bid);
  
+   /** Display informations about all packages
+    *  Used by compbenchmarks-core */
    virtual void displayAllPackages(void);
+ 
+   /** Display informations about all benchmarks
+    *  Used by compbenchmarks-core */
    virtual void displayAllBenchmarks(void);