Changeset 2808 in Sophya for trunk/SophyaLib/HiStats/histinit.cc

Timestamp:

Jun 14, 2005, 1:25:05 PM (20 years ago)

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/HiStats/histinit.cc (modified) (2 diffs)

trunk/SophyaLib/HiStats/histinit.cc

@@ -17 +17 @@
 /*!
    \defgroup HiStats HiStats module
-   This module contains histograms
+   This module contains histograms (1D, 2D) and 
+   classes for management of data sets as tables (NTuple, DataTable ...)
 */
  
@@ -25 +26 @@
   \class SOPHYA::HiStatsInitiator
   \ingroup HiStats
-  Histograms initiator
+  This class performs the initialisation for HiStats module.
+  More specifically, it registers PPF handlers for the following classes :
+  - Histo
+  - HProf
+  - HistoErr
+  - Histo2D
+  - NTuple
+  - XNTuple
+  - DataTable
+  - SwPPFDataTable
+
+  If the system linker/loader handles correctly static object initialisation, there
+  is no action required when writing programs. If not, an instance of the class must
+  be present before any other operation on the libray classes. 
 */
+
 HiStatsInitiator::HiStatsInitiator()
   : NToolsInitiator()