add comments

git-svn-id: svn+ssh://svn.in2p3.fr/class@541 0e7d625b-0364-4367-a6be-d5be4a48d228

source/trunk/include/CLASSBackEnd.hxx

@@ -25,6 +25,8 @@ using namespace std;
 typedef long long int cSecond;
 
 //-----------------------------------------------------------------------------//
+//! Class defining the common properties of all back end fuel cycle facilities
+
 /*!
  Define a CLASS Facility.
  The aim of these class is to gather all the commom properties of the

source/trunk/include/CLASSFacility.hxx

@@ -23,6 +23,8 @@ typedef long long int cSecond;
 
 class Scenario;
 //-----------------------------------------------------------------------------//
+//! Defines the common properties of all facilities
+
 /*!
  Define a CLASS Facility.
  The aim of these class is to gather all the commom properties of the facilities.

source/trunk/include/CLASSFuel.hxx

@@ -22,6 +22,8 @@
 using namespace std;
 
 //-----------------------------------------------------------------------------//
+//!  Allows to define PhysicsModels & EvolutionData as a CLASSFuel
+
 /*!
  Define a CLASS Object.
  The aim of these class is to handle PhysicsModels &

source/trunk/include/CLASSFuelPlan.hxx

@@ -24,6 +24,8 @@ typedef long long int cSecond;
 
 
 //-----------------------------------------------------------------------------//
+//! Allows a Reactor to change its CLASSFuel and/or burnup
+
 /*!
  Define a CLASS Object.
  The aim of these class is to allow a Reactor to change its CLASSFuel and/or burnup

source/trunk/include/CLASSLogger.hxx

@@ -47,6 +47,8 @@ using namespace std;
 #define _LOGTYPE_CLASS
 
 //-----------------------------------------------------------------------------//
+//!handle output stream in CLASS
+
 /*!
  Define a LogType.
  The aim of this class is to handle output stream in CLASS.
@@ -126,6 +128,8 @@ public:
 #define _CLASSLogger_CLASS_
 
 //-----------------------------------------------------------------------------//
+//! Object to handle output messages
+
 /*!
  Define a CLASSLogger.
  The aim of this class is to centralize the all CLASS software message inside a file.

source/trunk/include/CLASSNucleiFiliation.hxx

@@ -12,6 +12,8 @@
 using namespace std;
 
 //-----------------------------------------------------------------------------//
+//! Handle connection between nuclei (decay/reaction)
+
 /*!
  Define a nuclei as : Z A I.
  The aim of this class is to discribe each CLASSNucleiFiliation. It connects nuclei to their daughter nuclei through a nuclear process using the correct branching ratio.

source/trunk/include/CLASSObject.hxx

@@ -22,6 +22,8 @@
 using namespace std;
 
 //-----------------------------------------------------------------------------//
+//! Define common proporties of all objects
+
 /*!
  Define a CLASS Object.
  The aim of these class is to gather all the commom properties of all CLASS objects.

source/trunk/include/DecayDataBank.hxx

@@ -27,6 +27,8 @@ double ReactionRateWeightedDistance(IsotopicVector IV1, EvolutionData DB );
 double ReactionRateWeightedDistance(EvolutionData DB, IsotopicVector IV1  );
 
 //-----------------------------------------------------------------------------//
+//! Describe outcore radioactive decays 
+
 /*!
  Define a DecayDataBank.
  The aim of these class is to describe the evolution of "all" evoluting systems in CLASS.

source/trunk/include/EquivalenceModel.hxx

@@ -19,6 +19,8 @@
 using namespace std;
 
 //-----------------------------------------------------------------------------//
+
+//! Determines how to build a fresh fuel 
 /*!
  Define an EquivalenceModel.
  The aim of these class is to gather all the commum properties of all

source/trunk/include/EvolutionData.hxx

@@ -35,6 +35,8 @@ double 	Distance(IsotopicVector IV1, EvolutionData Evd1 );
 double 	Distance(EvolutionData Evd1, IsotopicVector IV1 );
 
 //-----------------------------------------------------------------------------//
+//! Store fuel inventory evolution , mean cross sections evolution, flux evolution, power , ...
+
 /*!
  Define an EvolutionData.
  The aim of these class is to describe the evolution of a single evoluting system in CLASS.

source/trunk/include/FabricationPlant.hxx

@@ -26,6 +26,8 @@ using namespace std;
 typedef long long int cSecond;
 
 //-----------------------------------------------------------------------------//
+//! CLASS object to build the fresh fuel (do chemical separation) & store it until core loading
+
 /*!
  Define a FabricationPLant.
  The aim of these class is to manage the manufacturing of reprocessed fuel.

source/trunk/include/IrradiationModel.hxx

@@ -31,6 +31,8 @@ typedef long long int cSecond;
 class ZAI;
 class CLASSLogger;
 //-----------------------------------------------------------------------------//
+//! The Bateman equation solver
+
 /*!
  Define an IrradiationModel.
  An IrradiationModel is a Bateman equation solving method.

source/trunk/include/IsotopicVector.hxx

@@ -18,6 +18,8 @@ using namespace std;
 typedef long long int cSecond;
 
 //-----------------------------------------------------------------------------//
+//! Allows to store & operate on radioactive sample
+
 /*!
  Define an Isotopicvector.
  An isotopicVector is a map of ZAI and double (e.g number of atoms).

source/trunk/include/PhysicsModels.hxx

@@ -21,6 +21,8 @@ using namespace std;
 typedef long long int cSecond;
 
 //-----------------------------------------------------------------------------//
+//! Container object of XSModel, EquivalenceModel and IrradiationModel
+
 /*!
  Define a contener of all physics models used for a specific couple (reactor,fuel).
  

source/trunk/include/Pool.hxx

@@ -20,8 +20,9 @@ class CLASSLogger;
 class DecayDataBank;
 
 //-----------------------------------------------------------------------------//
+//! Define the spent fuel pool
+
 /*!
- Define a Pool.
  This class deal with the management of the spent fuel pool
 
 

source/trunk/include/Reactor.hxx

@@ -26,8 +26,9 @@ class Storage;
 class CLASSLogger;
 
 //-----------------------------------------------------------------------------//
+//! Define the Reactor
+
 /*!
- Define a reactor.
  The aim of this class is to deal the evolution of the fuel inside a reactor.
  The fuel state in the reactor is describe in the IsotopicVector. Its evolution is contained in an EvolutionData
  

source/trunk/include/Scenario.hxx

@@ -28,8 +28,9 @@ class Pool;
 class Storage;
 
 //-----------------------------------------------------------------------------//
+//!  Define a Scenario (the whole electro-nuclear system)
+
 /*!
- Define a Scenario .
  The aim of these Scenario is to manage the park and its evolution and to lead all Storage, FabricationPlant, Reactor, Pool,...
  
  

source/trunk/include/SeparationPlant.hxx

@@ -21,9 +21,10 @@ class CLASSLogger;
 class DecayDataBank;
 
 //-----------------------------------------------------------------------------//
+//!  Define a SeparationPlant.
+
 /*!
- Define a SeparationPlant.
- The aim of this class is to separate an IV into several IV (MA, Pu, PF, etc...) and 
+ The aim of this class is to separate an IV into several IV (MA, Pu, PF, etc...) and
  to send it to one or several Storage
 
  @author NT

source/trunk/include/Storage.hxx

@@ -20,8 +20,9 @@ class CLASSLogger;
 class DecayDataBank;
 
 //-----------------------------------------------------------------------------//
+//! Define a Storage object
+
 /*!
- Define a Storage object
  A Storage is a CLASSBackEnd facility. It is almost the same as a Pool with a
  infinite cooling time.
  A CLASSFacility can take IsotopicVector(s) contained in a Storage but a Storage 

source/trunk/include/XSModel.hxx

@@ -19,8 +19,9 @@ using namespace std;
 class IsotopicVector;
 
 //-----------------------------------------------------------------------------//
+//!  Define a mean cross section predictor
+
 /*!
- Define a XS Interpolator 
 This is the mother class for methods related to XS prediction
 
 \warning