[Compbench-devel] CompBenchmarks++ main.h,NONE,1.1

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

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

Added Files:
	main.h 
Log Message:
First import.
Just Doxygen documentation.

--- NEW FILE: main.h ---
/* ----------------------------------------------------------------------------
   $Id: main.h,v 1.1 2006/09/25 16:44:26 xfred Exp $

   This is free software.
   For details, see the GNU Public License in the COPYING file, or
   Look http://www.fsf.org
   ------------------------------------------------------------------------- */

#ifndef H_CBMMAIN
#define H_CBMMAIN

/*! \mainpage CompBenchmarks 0.3.0 Internals
 *
 * \section intro_sec A foreword
 *
 * This document presents source layout and organisation of CompBenchmarks.
 * As a reminder, this software has been released under the GPL license.
 *
 * It'd be useful for developpers or contributers, as well as for people
 * who like to get an overview about how things are done.
 *
 * \section abstraction General organisation
 *
 * CompBenchmarks suite has been (re)written in C++, to add more flexibility.
 * Its core rely on a few abstracts (as in C++) definitions :
 * - \link CBMSystem operating system\endlink,
 * - \link CBMBenchmark benchmark\endlink or packages,
 * - \link CBMBenchmarkContextCompiler compiler\endlink,
 * - \link CBMUI user interface\endlink.
 *
 * Basically, operating system object is detected at CompBenchmarks
 * compilation time and instancied at run time to get others parts working.
 * Only one user interface as been coded for actual need, it allows the C++
 * core to interact with compbenchmarks-config. Many benchmarks have been
 * derivated from base benchmark object; each benchmark can use compilers and
 * options instances (e.g. through the operating system object).
 *
 * \section Example
 *
 * Compiled on Linux, program'll use a CBMSystemLinux instance. It can install
 * defined packages (like \link CBMBenchmarkGZIP gzip\endlink or \link
 * CBMBenchmarkBENCHPP Bench++\endlink) via Internet and uses some benchmarks on them.
 * Benchmarks can be hard-coded in CompBenchmarks (as, for gzip : \link CBMBenchmarkGZIP1 gzip-1c\endlink) or directly providen by packages (\link CBMBenchmarkBENCHPP_WHETSTONE benchpp-whetstone\endlink).
 *
 */

#endif