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

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

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

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

Index: Package.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Benchmark/Package.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** Package.h	4 Sep 2007 19:16:15 -0000	1.7
--- Package.h	4 Sep 2007 19:45:35 -0000	1.8
***************
*** 39,44 ****
     *  \sa BenchmarkVector */
    typedef struct {
!     std::string id;
!     CBM_BM      *instance;
    } BenchmarkCached;
  
--- 39,44 ----
     *  \sa BenchmarkVector */
    typedef struct {
!     std::string id;        /*!<  Benchmark's identifier */
!     CBM_BM      *instance; /*!<  Benchmark's instance */
    } BenchmarkCached;
  
***************
*** 115,123 ****
      /** Constructor
       *
!      *  Initialise the Package::system variable. */
      Package(class System *_system);
  
      /** Pure method to extract package
       *
       *  \return 1 if ok
       *  \sa Extract()
--- 115,125 ----
      /** Constructor
       *
!      *  Initialise the Package::system variable.
!      *  \param _system A CBM::System instance. */
      Package(class System *_system);
  
      /** Pure method to extract package
       *
+      *  \param _force toggle to 1 to force extraction, regardless of detected package's state.
       *  \return 1 if ok
       *  \sa Extract()
***************
*** 155,159 ****
       *
       *  Broadly speaking, this is ./configure
!      *  \param _curentCompiler Compiler to use
       *  \param _currentOptions Options to pass to compiler (through configuration mechanism)
       *  \sa Configure()
--- 157,161 ----
       *
       *  Broadly speaking, this is ./configure
!      *  \param _currentCompiler Compiler to use
       *  \param _currentOptions Options to pass to compiler (through configuration mechanism)
       *  \sa Configure()
***************
*** 165,170 ****
       *
       *  This could be a simple make, for instance.
- 
-      *  \param _force set this to 1 to force the build (regardless of package's state).
       *  \return 1 if ok
       *  \sa Make() */
--- 167,170 ----