From: jpr <jpr>
Date: Wed, 31 Aug 2005 15:54:50 +0000 (+0000)
Subject: Minor Doxygen problems
X-Git-Tag: Version1.2.bp~155
X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=35fea00ddb243a0d78fd679514995a8bb379803d;p=gdcm.git

Minor Doxygen problems
---

diff --git a/src/gdcmUtil.cxx b/src/gdcmUtil.cxx
index b9db1c16..0038698f 100644
--- a/src/gdcmUtil.cxx
+++ b/src/gdcmUtil.cxx
@@ -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)
 {
diff --git a/vtk/vtkGdcmReader.h b/vtk/vtkGdcmReader.h
index bdf3af32..b747f949 100644
--- a/vtk/vtkGdcmReader.h
+++ b/vtk/vtkGdcmReader.h
@@ -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