From: jpr <jpr>
Date: Tue, 18 Jan 2005 14:28:32 +0000 (+0000)
Subject: Doxygenation (Print method)
X-Git-Tag: Version1.0.bp~266
X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=a891240601e102b6b07ce593d9b9b28948149e72;p=gdcm.git

Doxygenation (Print method)
---

diff --git a/src/gdcmBase.cxx b/src/gdcmBase.cxx
index 2b068043..a74a2cdc 100644
--- a/src/gdcmBase.cxx
+++ b/src/gdcmBase.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBase.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/16 04:50:40 $
-  Version:   $Revision: 1.6 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.7 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -44,6 +44,7 @@ Base::~Base()
 /**
  * \brief   Print all the object
  * @param   os The output stream to be written to.
+ * @param   indent indent
  */
 void Base::Print(std::ostream &, std::string const & )
 {
diff --git a/src/gdcmDicomDirImage.cxx b/src/gdcmDicomDirImage.cxx
index 74632269..0ddbfc46 100644
--- a/src/gdcmDicomDirImage.cxx
+++ b/src/gdcmDicomDirImage.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirImage.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 07:53:42 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.18 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -42,6 +42,7 @@ DicomDirImage::~DicomDirImage()
 /**
  * \brief   Prints the Object
  * @param os ostream to write to
+ * @param   indent indent
  * @return
  */ 
 void DicomDirImage::Print(std::ostream &os, std::string const & )
diff --git a/src/gdcmDicomDirMeta.cxx b/src/gdcmDicomDirMeta.cxx
index b21b126f..43f2c056 100644
--- a/src/gdcmDicomDirMeta.cxx
+++ b/src/gdcmDicomDirMeta.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirMeta.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 07:53:42 $
-  Version:   $Revision: 1.22 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.23 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -46,6 +46,7 @@ DicomDirMeta::~DicomDirMeta()
 /**
  * \brief   Prints the Meta Elements
  * @param os ostream to write to 
+ * @param   indent indent
  */ 
 void DicomDirMeta::Print(std::ostream &os, std::string const & )
 {
diff --git a/src/gdcmDicomDirPatient.cxx b/src/gdcmDicomDirPatient.cxx
index 81ba4327..abf4d1b2 100644
--- a/src/gdcmDicomDirPatient.cxx
+++ b/src/gdcmDicomDirPatient.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirPatient.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 11:39:59 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.28 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -53,6 +53,7 @@ DicomDirPatient::~DicomDirPatient()
 /**
  * \brief   Prints the Object
  * @param os ostream to write to 
+ * @param   indent indent
  */ 
 void DicomDirPatient::Print(std::ostream &os, std::string const & )
 {
diff --git a/src/gdcmDicomDirSerie.cxx b/src/gdcmDicomDirSerie.cxx
index 2809fdea..50dbfa91 100644
--- a/src/gdcmDicomDirSerie.cxx
+++ b/src/gdcmDicomDirSerie.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirSerie.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 11:39:59 $
-  Version:   $Revision: 1.29 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.30 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -52,6 +52,7 @@ DicomDirSerie::~DicomDirSerie()
 /**
  * \brief   Prints the Object
  * @param os ostream to write to
+ * @param   indent indent
  */ 
 void DicomDirSerie::Print(std::ostream &os, std::string const &)
 {
diff --git a/src/gdcmDicomDirStudy.cxx b/src/gdcmDicomDirStudy.cxx
index bdb78840..92630664 100644
--- a/src/gdcmDicomDirStudy.cxx
+++ b/src/gdcmDicomDirStudy.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirStudy.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 11:39:59 $
-  Version:   $Revision: 1.26 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.27 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -51,6 +51,7 @@ DicomDirStudy::~DicomDirStudy()
 /**
  * \brief   Prints the Object
  * @param os ostream to write to 
+ * @param   indent indent
  * @return
  */ 
 void DicomDirStudy::Print(std::ostream &os, std::string const & )
diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx
index f15a7536..d56ff7c2 100644
--- a/src/gdcmDict.cxx
+++ b/src/gdcmDict.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDict.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 11:39:59 $
-  Version:   $Revision: 1.67 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.68 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -91,6 +91,7 @@ Dict::~Dict()
  * \brief   Print all the dictionary entries contained in this dictionary.
  *          Entries will be sorted by tag i.e. the couple (group, element).
  * @param   os The output stream to be written to.
+ * @param   indent indent 
  */
 void Dict::Print(std::ostream &os, std::string const & )
 {
diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx
index a44e8fdc..f4ae8c8c 100644
--- a/src/gdcmDictSet.cxx
+++ b/src/gdcmDictSet.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 11:40:00 $
-  Version:   $Revision: 1.54 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.55 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -65,6 +65,7 @@ DictSet::~DictSet()
  * \brief   Print, in an informal fashion, the list of all the dictionaries
  *          contained is this DictSet, along with their respective content.
  * @param   os Output stream used for printing.
+ * @param   indent indent
  */
 void DictSet::Print(std::ostream &os, std::string const & )
 {
diff --git a/src/gdcmDocEntry.cxx b/src/gdcmDocEntry.cxx
index a1718533..75b83279 100644
--- a/src/gdcmDocEntry.cxx
+++ b/src/gdcmDocEntry.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 08:01:41 $
-  Version:   $Revision: 1.42 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.43 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -55,6 +55,7 @@ DocEntry::DocEntry(DictEntry *in)
 /**
  * \brief   Prints the common part of ValEntry, BinEntry, SeqEntry
  * @param   os ostream we want to print in
+ * @param indent Indentation string to be prepended during printing
  */
 void DocEntry::Print(std::ostream &os, std::string const & )
 {
diff --git a/src/gdcmElementSet.cxx b/src/gdcmElementSet.cxx
index e43177e8..8f81f255 100644
--- a/src/gdcmElementSet.cxx
+++ b/src/gdcmElementSet.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 11:40:00 $
-  Version:   $Revision: 1.44 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.45 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -58,7 +58,7 @@ ElementSet::~ElementSet()
   * \brief   Prints the Header Entries (Dicom Elements)
   *          from the H Table
   * @param os ostream to write to  
-  * @return
+  * @param indent Indentation string to be prepended during printing
   */ 
 void ElementSet::Print(std::ostream &os, std::string const & )
 {
@@ -84,8 +84,8 @@ void ElementSet::Print(std::ostream &os, std::string const & )
 /**
   * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
-  * @param os ostream to write to  
-  * @return
+  * @param fp ofstream to write to  
+  * @param filetype filetype
   */ 
 void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
 {
diff --git a/src/gdcmException.cxx b/src/gdcmException.cxx
index 471bc41e..bea47bb1 100644
--- a/src/gdcmException.cxx
+++ b/src/gdcmException.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmException.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 08:01:41 $
-  Version:   $Revision: 1.24 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.25 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -120,6 +120,7 @@ std::string Exception::getName() const throw()
 /**
  * \brief Exception::operator <<
  * @param os ostream to write to
+ * @param e exception to raise
  */
  std::ostream& operator<<(std::ostream &os, const Exception &e) {
   try {  
diff --git a/src/gdcmJPEGFragment.cxx b/src/gdcmJPEGFragment.cxx
index 188f8226..9b5733b5 100644
--- a/src/gdcmJPEGFragment.cxx
+++ b/src/gdcmJPEGFragment.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmJPEGFragment.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 03:05:55 $
-  Version:   $Revision: 1.4 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.5 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -69,6 +69,7 @@ void JPEGFragment::Print( std::ostream &os, std::string indent )
 
 /**
  * \brief Decompress 8bits JPEG Fragment
+ * @param fp ifstream to write to
  * @param buffer     output (data decompress)
  * @param nBits      8/12 or 16 bits jpeg
  */
diff --git a/src/gdcmSeqEntry.cxx b/src/gdcmSeqEntry.cxx
index ed092100..243ae59c 100644
--- a/src/gdcmSeqEntry.cxx
+++ b/src/gdcmSeqEntry.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/18 12:16:10 $
-  Version:   $Revision: 1.46 $
+  Date:      $Date: 2005/01/18 14:28:32 $
+  Version:   $Revision: 1.47 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -193,7 +193,6 @@ SQItem *SeqEntry::GetFirstEntry()
    return NULL;
 } 
 
-
 /**
  * \brief   Get the next SQItem while visiting the SeqEntry
  * \note : meaningfull only if GetFirstEntry already called