Changeset 913 in Sophya for trunk/SophyaLib/BaseTools/sophyainit.cc

Timestamp:

Apr 13, 2000, 5:58:41 PM (25 years ago)

Author:

ansari

Message:

Documentation + Modifs mineures (namespace, etc..) - Reza 13/4/2000

File:

• trunk/SophyaLib/BaseTools/sophyainit.cc (modified) (1 diff)

trunk/SophyaLib/BaseTools/sophyainit.cc

@@ -18 +18 @@
 // ---  Classe d'initialisation de SOPHYA, (PPersistMgr en particulier)
 int SophyaInitiator::FgInit = 0;
+
+/*!
+   \namespace SOPHYA
+   \brief This is the namespace for the whole Sophya package
+*/
+
+/*!
+   \defgroup SysTools SysTools module
+   This module contains classes and functions which define the 
+   general framework for \b Sophya package such as the simple
+   persistence, serialisation mechanism through \b PPersist,
+   \b POutPersist, \b PInPersist classes. It contains also
+   few utility classes such as the \b NDataBlock<T>, (template 
+   numerical arrays with reference counting and sharing)
+   \b DataCards and \b PDynLinker (Dynamic link handler) classes.  
+  
+*/
+
+/*!
+  \class SOPHYA::SophyaInitiator
+  \ingroup SysTools
+  Each Sophya module may contain an initialiser class which should
+  be a sub-class of SophyaInitiator.  
+*/
 
 SophyaInitiator::SophyaInitiator()