Changeset 2805 in Sophya for trunk/SophyaLib/BaseTools/segdatablock.h

Timestamp:

Jun 9, 2005, 6:20:00 PM (20 years ago)

Author:

ansari

Message:

MAJ commentaires pour documentation doxygen - Reza 9 Juin 2005

File:

• trunk/SophyaLib/BaseTools/segdatablock.h (modified) (4 diffs)

trunk/SophyaLib/BaseTools/segdatablock.h

@@ -14 +14 @@
 #include <typeinfo>
 
-namespace SOPHYA {
-
-////////////////////////////////////////////////////////////////
-//// ---------------- Class SegDBInterface ------------------ //
-//// ----------------- Class SegDataBlock ------------------- //
-////////////////////////////////////////////////////////////////
-
 /*!
    \class SOPHYA::SegDBInterface
@@ -26 +19 @@
    Interface definition for segmented data container (template class).
 */
+/*!
+   \class SOPHYA::SegDataBlock
+   \ingroup BaseTools
+   Template class impementing segmented data container in memory with 
+   management of reference sharing. 
+*/
+
+namespace SOPHYA {
+
+////////////////////////////////////////////////////////////////
+//// ---------------- Class SegDBInterface ------------------ //
+//// ----------------- Class SegDataBlock ------------------- //
+////////////////////////////////////////////////////////////////
+
 template <class T>
 class SegDBInterface : public AnyDataObj {
@@ -49 +56 @@
 };
 
+
 // classe de container avec partage de reference
-//! Segmented data container with reference sharing
-/*!
-   \class SOPHYA::SegDataBlock
-   \ingroup BaseTools
-   Template class impementing segmented data container in memory with 
-   management of reference sharing. 
-*/
 template <class T>
 class SegDataBlock : public SegDBInterface<T> {
@@ -242 +243 @@
     mSRef = NULL;
   }
-  //! SDREF structure for reference management - for internal use by SegDataBlock
+  /*! \cond 
+    SDREF structure for reference management - for internal use by SegDataBlock
+  */
   typedef struct {
-    size_t nref;      //!< Number of references to the data structure
-    uint_8 dsid;      //!< Data structure Id - Used by FIO_SegDataBlock
+    size_t nref;      // Number of references to the data structure
+    uint_8 dsid;      // Data structure Id - Used by FIO_SegDataBlock
     std::vector<T *> dseg;
     size_t segsize;
   } SDREF;
-
+  /*! \endcond */
   SDREF *  mSRef;    //!< SDREF structure for reference sharing
 };