X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=src%2FgdcmPixelWriteConvert.cxx;h=fc15bfb52eb3046bdf572222a67297fba22eada1;hb=9b08ef2e93023e33dad3326a0c7d6b5db7b72cd4;hp=899f816f84e8047ed78399f4cfa27119930b3356;hpb=0ad9dae4659b21bfd5c834c1af724eab4dcdf4f6;p=gdcm.git

diff --git a/src/gdcmPixelWriteConvert.cxx b/src/gdcmPixelWriteConvert.cxx
index 899f816f..fc15bfb5 100644
--- a/src/gdcmPixelWriteConvert.cxx
+++ b/src/gdcmPixelWriteConvert.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmPixelWriteConvert.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/23 10:12:34 $
-  Version:   $Revision: 1.5 $
+  Date:      $Date: 2005/02/16 11:20:51 $
+  Version:   $Revision: 1.8 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -23,50 +23,55 @@ namespace gdcm
 {
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
-
-/// \brief Construcror
+/**
+ * \brief Constructor
+ */
 PixelWriteConvert::PixelWriteConvert() 
 {
-   ReadData = 0;
+   ReadData     = 0;
    ReadDataSize = 0;
 
-   UserData = 0;
+   UserData     = 0;
    UserDataSize = 0;
 }
 
-/// \brief Destructor
+/**
+ * \brief Destructor
+ */
 PixelWriteConvert::~PixelWriteConvert() 
 {
 }
 
 //-----------------------------------------------------------------------------
 // Public
-
 /**
  * \brief   SetReadData
- * @param   data data
- * @param   size size
+ * @param   data data (uint8_t is for prototyping. if your data is not uint8_t
+ *                     just cast the pointer for calling the method)
+ * @param   size size in bytes
  */
-void PixelWriteConvert::SetReadData(uint8_t *data,size_t size)
+void PixelWriteConvert::SetReadData(uint8_t *data, size_t size)
 {
    ReadData = data;
    ReadDataSize = size;
 }
 
 /**
- * \brief   SetUserData
- * @param   data data
- * @param   size size
+ * \brief   Sets User Data
+ * @param   data data (uint8_t is for prototyping. if your data is not uint8_t
+ *                     just cast the pointer for calling the method)
+ * @param   size size in bytes
  */
-void PixelWriteConvert::SetUserData(uint8_t *data,size_t size)
+void PixelWriteConvert::SetUserData(uint8_t *data, size_t size)
 {
    UserData = data;
    UserDataSize = size;
 }
 
 /**
- * \brief   GetData
- * @return  data 
+ * \brief   Get Data (UserData or ReadData)
+ * @return  data data data (uint8_t is for prototyping. if your data is not uint8_t
+ *                     just cast the returned pointer)
  */
 uint8_t *PixelWriteConvert::GetData()
 {
@@ -81,8 +86,8 @@ uint8_t *PixelWriteConvert::GetData()
 }
 
 /**
- * \brief   GetDataSize
- * @return  size 
+ * \brief   Get Data Size (UserData or ReadData)
+ * @return  size size in bytes
  */
 size_t PixelWriteConvert::GetDataSize()
 {
@@ -96,5 +101,14 @@ size_t PixelWriteConvert::GetDataSize()
    }
 }
 
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+// Print
+
 //-----------------------------------------------------------------------------
 } // end namespace gdcm