JG ROOT Tools libraries  version 5.0 - august 2014
GRootToolsMainDoc.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file GRootToolsMainDoc.hh
3  *
4  * Main documentation page file.
5  */
6 //======================================================================
7 
8 /*! \mainpage GRootTools
9  *
10  * \author J. Giovinazzo (giovinaz@cenbg.in2p3.fr)
11  *
12  * The GRootTools libraries package provides a set of libraries to
13  * be used within the ROOT environment.
14  * They can be used either with the ROOT library in running programs,
15  * or within a ROOT interactive session.
16  *
17  * \ref groot_release
18  *
19  * \ref groot_fft
20  *
21  * <H2>Mathematics additional documentation</H2>
22  *
23  * - \ref groot_algebre2d
24  * - \ref groot_ellipse
25  *
26  *
27  * <H2>ROOT dictionary generation</H2>
28  *
29  * <B>ROOT version 6.xx</B>
30  *
31  * - use of <B><TT>rootcling</TT></B> instead of rootcint
32  * \code
33 
34  rootcling -f MyLib_dict.cpp -s libMyLib.so -rml libMyLib.so [-c -p] -I<include_dirs> [-I<install_incl_dir>] <incl_files.hh> MyLib_linkdef.h
35 
36  \endcode
37  *
38  * - options <B>-c -p</B> are not required with rootcling
39  *
40  * - the flag \code -I<install_incl_dir> \endcode
41  * is needed if ROOT does not find the includes when loading
42  * the library (or the ROOT_INCLUDE_PATH variable can be defined
43  * instead)
44  *
45  * - \b warning: when loading the libraries in a ROOT session, each library
46  * must be loaded only once (this was not the case with ROOT 5.xx: for
47  * example, the Xerces-c lib was loaded 2x with macro files
48  * loading sets of libraries, with no problem - this is not
49  * the case any more).
50  *
51  *
52  * <B>ROOT version 5.xx</B>
53  *
54  * \code
55 
56  rootcint -f MyLib_dict.cpp -c -p -I<include_dirs> [-I<install_incl_dir>] <incl_files.hh> MyLib_linkdef.h
57 
58  \endcode
59  *
60  *
61  */