]> Creatis software - gdcm.git/commitdiff
Minor Doxygen problems
authorjpr <jpr>
Wed, 31 Aug 2005 15:54:50 +0000 (15:54 +0000)
committerjpr <jpr>
Wed, 31 Aug 2005 15:54:50 +0000 (15:54 +0000)
src/gdcmUtil.cxx
vtk/vtkGdcmReader.h

index b9db1c163a03d4abef26bf7c724c6c1e7d632a3f..0038698f6d20ab310a92b2e1cc8725eabd0189ca 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmUtil.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/08/25 14:55:47 $
-  Version:   $Revision: 1.160 $
+  Date:      $Date: 2005/08/31 15:54:50 $
+  Version:   $Revision: 1.161 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -201,7 +201,8 @@ return true;
 /**
  * \brief  Checks whether an 'area' is printable or not (in order
  *         to avoid corrupting the terminal of invocation when printing)
- * @param s string to check
+ * @param s area to check (uint8_t is just for prototyping. feel free to cast)
+ * @param l area length to check
  */
 bool Util::IsCleanArea(uint8_t *s, int l)
 {
@@ -217,7 +218,8 @@ bool Util::IsCleanArea(uint8_t *s, int l)
 /**
  * \brief  Weed out a string from the non-printable characters (in order
  *         to avoid corrupting the terminal of invocation when printing)
- * @param s string to remove non printable characters from
+ * @param s area to check (uint8_t is just for prototyping. feel free to cast)
+ * @param l area length to check
  */
 std::string Util::CreateCleanString(std::string const &s)
 {
@@ -248,7 +250,8 @@ std::string Util::CreateCleanString(std::string const &s)
 /**
  * \brief  Weed out a string from the non-printable characters (in order
  *         to avoid corrupting the terminal of invocation when printing)
- * @param s string to remove non printable characters from
+ * @param s area to process (uint8_t is just for prototyping. feel free to cast)
+ * @param l area length to check
  */
 std::string Util::CreateCleanString(uint8_t *s, int l)
 {
index bdf3af329b34d155ddbba6bc39d1aee398e9172e..b747f9490c03b091a892f2d8b7ca24bb38b7861b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: vtkGdcmReader.h,v $
   Language:  C++
-  Date:      $Date: 2005/08/30 14:40:35 $
-  Version:   $Revision: 1.28 $
+  Date:      $Date: 2005/08/31 15:54:51 $
+  Version:   $Revision: 1.29 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -68,8 +68,9 @@ public:
 
    vtkGetObjectMacro(LookupTable, vtkLookupTable);
 
-/**
- * \brief Sets the LoadMode as a boolean string. 
+// FIXME : HOW to doxygen a VTM macro?
+/*
+ * \ brief Sets the LoadMode as a boolean string. 
  *        gdcm.LD_NOSEQ, gdcm.LD_NOSHADOW, gdcm.LD_NOSHADOWSEQ... 
  *        (nothing more, right now)
  *        WARNING : before using NO_SHADOW, be sure *all* your files