Changeset 3408 in Sophya

Timestamp:

Nov 23, 2007, 11:54:28 PM (18 years ago)

Author:

ansari

Message:

modifs commentaires pour doc par doxygen - Reza 23/11/2007

Location:

trunk/SophyaLib

Files:

• BaseTools/srandgen.c (modified) (1 diff)
• BaseTools/stsrand.cc (modified) (2 diffs)
• TArray/arrctcast.h (modified) (6 diffs)

trunk/SophyaLib/BaseTools/srandgen.c

@@ -428 +428 @@
 
 
-/*! 
-  \ingroup  BaseTools
-  \class SOPHYA::RandomGenerator
-  \brief Random number generator
-  
-  This is a class with static methods, providing an alternative interface 
-  to random number generations functions declared in srandgen.h.
-
-  \sa frand01 drand01 frandpm1 drandpm1 
-  \sa GauRnd PoissRand
-  \sa Ini_Ranf_Quick Ini_Ranf Get_Ranf Auto_Ini_Ranf
-*/
 
 /*==========================================================================*/

trunk/SophyaLib/BaseTools/stsrand.cc

@@ -11 +11 @@
    \class RandomGenerator
    \ingroup BaseTools
+   \brief Random number generator
+
    This class is a thread-safe random number generator.
    Its PPF handler can be used to save the complete state of the class and the underlying
@@ -16 +18 @@
 
    \sa SOPHYA::ObjFileIO<RandomGenerator>
+
+   \sa frand01 drand01 frandpm1 drandpm1 
+   \sa GauRnd PoissRand
+   \sa Ini_Ranf_Quick Ini_Ranf Get_Ranf Auto_Ini_Ranf
+
 
 */

trunk/SophyaLib/TArray/arrctcast.h

@@ -18 +18 @@
 //******************************************
 // Classe NDCBridge : Bridge sur NDataBlock, utile pour cast - sans conversion - de type 
-//! Special Bridge class to be used the ArrayCast class 
+/*! 
+  \class NDCBridge
+  \brief Special Bridge class to be used the ArrayCast class 
+  \ingroup TArray 
+*/
 template <class T>
 class NDCBridge : public Bridge {
@@ -35 +39 @@
 // Fonction de cast de type de contenu - sans conversion - de tableaux
 // pour tableau packe en memoire
-//! Class to handle Array content cast without conversion (shared data)
+/*! 
+  \ingroup TArray 
+  \brief Function to handle Array content cast without conversion (shared data)
+*/
 template <class T1, class T2>                                                               
 TArray< T2 > ArrayCast( TArray< T1 > & a, T2 ct, sa_size_t doff=0, sa_size_t dstep=1) 
@@ -72 +79 @@
 //******************************************
 // cast de contenu - sans conversion - tableau complex vers float
-//! Complex to real array cast - without conversion (shared data) 
+/*! 
+  \ingroup TArray 
+  \brief Complex to real array cast - without conversion (shared data) 
+*/
 template <class T>
 TArray<T> ArrCastC2R(TArray< complex<T> > & a)  
@@ -82 +92 @@
 //******************************************
 // cast de contenu - sans conversion - tableau float vers complex
-//! Real to complex array cast - without conversion (shared data)
+/*! 
+  \ingroup TArray 
+  \brief Real to complex array cast - without conversion (shared data)
+*/
 template <class T>
 TArray< complex<T> > ArrCastR2C(TArray< T > & a)  
@@ -95 +108 @@
 // Acces a la partie reelle d'un tableau complex - en shared data
 // To access real part of a complex array (shared data)
+/*! 
+  \ingroup TArray 
+  \brief Return the real part of a complex array (shared data)
+*/
 template <class T>
 TArray<T> SDRealPart(TArray< complex<T> > & a)  
@@ -105 +122 @@
 // Acces a la partie imaginaire d'un tableau complex - en shared data
 // To access imaginary part of a complex array (shared data)
+/*! 
+  \ingroup TArray 
+  \brief Return the imaginary part of a complex array (shared data)
+*/
 template <class T>
 TArray<T> SDImagPart(TArray< complex<T> > & a)