Changeset 890 in Sophya for trunk/SophyaLib/TArray/basarr.cc

Timestamp:

Apr 11, 2000, 7:59:04 PM (25 years ago)

Author:

ansari

Message:

debut de doc pour verif par rz (cmv 11/4/00

File:

• trunk/SophyaLib/TArray/basarr.cc (modified) (6 diffs)

trunk/SophyaLib/TArray/basarr.cc

@@ -8 +8 @@
 #include "basarr.h"
 
-
-
 // Variables statiques globales
 char * BaseArray::ck_op_msg_[6] = {"???", "Size(int )", "IsPacked(int )", 
-                                 "Stride(int )", "ElemCheckBound()", "operator()" };
+                       "Stride(int )", "ElemCheckBound()", "operator()" };
 uint_4 BaseArray::max_nprt_ = 50;
 uint_4 BaseArray::prt_lev_ = 0;
@@ -22 +20 @@
 
 //  1/ Gestion des impressions 
+//! Set maximum number of printed elements and print level
+/*!
+  \param nprt : maximum number of print
+  \param lev  : print level
+*/
 void BaseArray::SetMaxPrint(uint_4 nprt, uint_4 lev)
 {
@@ -28 +31 @@
 }
 
+//! Set Size threshold for parallel routine call
+/*!
+  \param thr : thresold value
+*/
 void BaseArray::SetOpenMPSizeThreshold(uint_8 thr)
 {
@@ -150 +157 @@
 // -------------------------------------------------------
 
-// Les constructeurs 
+//! Default constructor
 BaseArray::BaseArray()
   : mInfo(NULL)
-// Default constructor
 {
   ndim_ = 0;
@@ -172 +178 @@
 }
 
-// Destructeur 
+//! Destructor 
 BaseArray::~BaseArray()
 {
@@ -178 +184 @@
 
 
+//! Returns true if \b ndim and \b sizes are equal
+/*!
+  \param a : array to be compared
+  \return true if ndim and sizes are equal, false if not
+*/
 bool BaseArray::CompareSizes(const BaseArray& a)
 {