* gdcm/Doc many doxygen changes:

[gdcm.git] / src / gdcmHeader.cxx

diff --git a/src/gdcmHeader.cxx b/src/gdcmHeader.cxx
index 7073582b4ddde10946270cc0aec96a2680940e9c..67e23959ebfc482433b75ad681a85aba91d30743 100644 (file)
--- a/src/gdcmHeader.cxx
+++ b/src/gdcmHeader.cxx
@@ -1321,15 +1321,16 @@ int gdcmHeader::SetPubElValByName(string content, string TagName) {
  * \brief   Accesses an existing gdcmElValue in the PubElVals of this instance
  *          through it's (group, element) and modifies it's length with
  *          the given value.
- *             NOT FOR BOZOs !
- * @param   contents new length to substitute with
+ * \warning Use with extreme caution.
+ * @param   length new length to substitute with
  * @param   group   group of the ElVal to modify
  * @param   element element of the ElVal to modify
+ * @return  1 on success, 0 otherwise.
  */
-int gdcmHeader::SetPubElValLengthByNumber(guint32 lgr, guint16 group,
+int gdcmHeader::SetPubElValLengthByNumber(guint32 length, guint16 group,
                                     guint16 element)
 {
-       return (  PubElVals.SetElValueLengthByNumber (lgr, group, element) );
+       return (  PubElVals.SetElValueLengthByNumber (length, group, element) );
 }
 
 /**
@@ -1340,6 +1341,7 @@ int gdcmHeader::SetPubElValLengthByNumber(guint32 lgr, guint16 group,
  * @param   content new value to substitute with
  * @param   group   group of the ElVal to modify
  * @param   element element of the ElVal to modify
+ * @return  1 on success, 0 otherwise.
  */
 int gdcmHeader::SetShaElValByNumber(string content,
                                     guint16 group, guint16 element)