]> Creatis software - gdcm.git/commitdiff
Doxygenation
authorjpr <jpr>
Thu, 6 Jan 2005 16:29:22 +0000 (16:29 +0000)
committerjpr <jpr>
Thu, 6 Jan 2005 16:29:22 +0000 (16:29 +0000)
src/gdcmDocEntrySet.cxx
src/gdcmDocument.cxx

index a2bffcc83c906a489dd55001314a8341c401279a..8c817b5a927a680b7443739258be9456089c459f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 15:36:48 $
-  Version:   $Revision: 1.30 $
+  Date:      $Date: 2005/01/06 16:29:22 $
+  Version:   $Revision: 1.31 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -74,7 +74,7 @@ std::string DocEntrySet::GetEntryByName(TagName const & name)
 /**
  * \brief   Request a new virtual dict entry to the dict set
  * @param   group     group  number of the underlying DictEntry
- * @param   element  element number of the underlying DictEntry
+ * @param   elem  element number of the underlying DictEntry
  * @param   vr     VR of the underlying DictEntry
  * @param   fourth owner group
  * @param   name   english name
@@ -93,8 +93,9 @@ DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group,uint16_t elem,
  * \brief   Build a new Val Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   group group   number of the underlying DictEntry
- * @param   elem  element number of the underlying DictEntry
+ * @param   group group   number of the new Entry
+ * @param   elem  element number of the new Entry
+ * @param   vr     VR of the new Entry 
  */
 ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group,uint16_t elem,
                                            TagName const & vr) 
@@ -117,8 +118,9 @@ ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group,uint16_t elem,
  * \brief   Build a new Bin Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   group group   number of the underlying DictEntry
- * @param   elem  element number of the underlying DictEntry
+ * @param   group group   number of the new Entry
+ * @param   elem  element number of the new Entry
+ * @param   vr     VR of the new Entry 
  */
 BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group,uint16_t elem,
                                            TagName const & vr) 
@@ -140,8 +142,8 @@ BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group,uint16_t elem,
  * \brief   Build a new Seq Entry from all the low level arguments. 
  *          Check for existence of dictionary entry, and build
  *          a default one when absent.
- * @param   Group group   number of the underlying DictEntry
- * @param   Elem  element number of the underlying DictEntry
+ * @param   group group   number of the new Entry
+ * @param   elem  element number of the new Entry
  */
 SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t group,uint16_t elem) 
 {
@@ -210,7 +212,7 @@ DictEntry *DocEntrySet::GetDictEntryByName(TagName const & name)
  *          group and element. The public dictionary has precedence on the
  *          shadow one.
  * @param   group   group number of the searched DictEntry
- * @param   element element number of the searched DictEntry
+ * @param   elem element number of the searched DictEntry
  * @return  Corresponding DictEntry when it exists, NULL otherwise.
  */
 DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group,uint16_t elem) 
index 2a2c88e1be9607f3d61d47d79ca7d94c705abb58..0098a5720af7654286537d6192db3731e2ffe43a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 16:05:06 $
-  Version:   $Revision: 1.158 $
+  Date:      $Date: 2005/01/06 16:33:54 $
+  Version:   $Revision: 1.159 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -937,7 +937,8 @@ bool Document::SetEntryByNumber(uint8_t*content, int lgth,
 /**
  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
  *          and modifies it's content with the given value.
- * @param   content new value (string) to substitute with
+ * @param  content new value (string) to substitute with
+ * @param  entry Entry to be modified
  */
 bool Document::SetEntry(std::string const & content,ValEntry* entry)
 {
@@ -953,9 +954,10 @@ bool Document::SetEntry(std::string const & content,ValEntry* entry)
  * \brief   Accesses an existing BinEntry (i.e. a Dicom Element)
  *          and modifies it's content with the given value.
  * @param   content new value (void*  -> uint8_t*) to substitute with
+ * @param  entry Entry to be modified 
  * @param   lgth new value length
  */
-bool Document::SetEntry(uint8_t* content, int lgth,BinEntry* entry)
+bool Document::SetEntry(uint8_t* content, int lgth, BinEntry* entry)
 {
    if(entry)
    {