GCpp general purpose C++ library  version 1.0
GCppDocMainPage.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file GCppDocMainPage.hh
3  *
4  * Documentation main page file
5  */
6 //======================================================================
7 /*! \mainpage
8  *
9  * \author J. Giovinazzo (giovinaz@cenbg.in2p3.fr)
10  *
11  * The GCpp libraries are a set of basic C++ classes and functions.
12  *
13  *
14  * \par Compilation
15  *
16  * Environnement variables:
17  *
18  * The library needs:
19  *
20  *
21  * \par Use of the library
22  *
23  * When the library is compiled, scrits to get compilation options
24  * when using the library:
25  * - \b gcpp_inc : provide include library flags for compilation
26  * - \b gcpp_lib : provide shared object library flags for link
27  *
28  * In addition, a shell script (csh/tcsh) is created automatically to
29  * define environment variables.
30  * The \b bin and \b lib folders are added to the standard environment.
31  *
32  *
33  * \par Documentation pages
34  *
35  * \ref gcpp_templates
36  * Describes the main lines of the template classes.
37  *
38  * \ref gcpp_fft_doc
39  * Describes the FFT classes.
40 *
41  * \ref gcpp_messages
42  *
43  * \ref gcpp_release
44  *
45  */
46 //======================================================================