Changeset 894 in Sophya for trunk/SophyaLib/TArray/fioarr.h

Timestamp:

Apr 12, 2000, 7:42:33 PM (25 years ago)

Author:

ansari

Message:

documentation cmv 12/4/00

File:

• trunk/SophyaLib/TArray/fioarr.h (modified) (2 diffs)

trunk/SophyaLib/TArray/fioarr.h

@@ -15 +15 @@
 namespace SOPHYA {
 /////////////////////////////////////////////////////////////////////////
-// Classe pour la gestion de persistance
+//! Class for persistent management of TArray
+/*!
+  This class manage also persistence for TMatrix and TVector.
+  \sa TArray TMatrix TVector.
+ */
 template <class T>
 class FIO_TArray : public  PPersist  {
@@ -30 +34 @@
   virtual void ReadSelf(PInPersist&);           
   virtual void WriteSelf(POutPersist&) const;  
-  TArray<T> * dobj;
-  bool ownobj;
+  TArray<T> * dobj; //!< Pointer to the connected TArray
+  bool ownobj; //!< true if the connected object belong to the class
 };
 
+//! Write TArray \b obj into POutPersist stream \b os
 template <class T>
 inline POutPersist& operator << (POutPersist& os, TArray<T> & obj)
 { FIO_TArray<T> fio(&obj);  fio.Write(os);  return(os); }
+
+//! Read TArray \b obj from PInPersist stream \b os
 template <class T>
 inline PInPersist& operator >> (PInPersist& is, TArray<T> & obj)