From: jpr Date: Mon, 19 Apr 2004 14:59:20 +0000 (+0000) Subject: doxygenation X-Git-Tag: Version0.5.bp~249 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;ds=inline;h=5ac719be199bf3cd4f9c9c68c88eff4dc7227531;p=gdcm.git doxygenation --- diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index 7b46a51a..500f6f6b 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -43,6 +43,16 @@ gdcmFile::gdcmFile(gdcmHeader *header) { * one sets an a posteriori shadow dictionary (efficiency can be * seen as a side effect). * @param filename file to be opened for parsing + * @param exception_on_error whether we throw an exception or not + * @param enable_sequences = true to allow the header + * to be parsed *inside* the SeQuences, + * when they have an actual length + * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files + * @param ignore_shadow to allow skipping the shadow elements, + * to save memory space. + * \warning The TRUE value for this param has to be used + * with a FALSE value for the 'enable_sequence' param. + * ('public elements' may be embedded in 'shadow Sequences') */ gdcmFile::gdcmFile(std::string & filename, bool exception_on_error, @@ -71,6 +81,16 @@ gdcmFile::gdcmFile(std::string & filename, * one sets an a posteriori shadow dictionary (efficiency can be * seen as a side effect). * @param filename file to be opened for parsing + * @param exception_on_error whether we throw an exception or not + * @param enable_sequences = true to allow the header + * to be parsed *inside* the SeQuences, + * when they have an actual length + * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files + * @param ignore_shadow to allow skipping the shadow elements, + * to save memory space. + * \warning The TRUE value for this param has to be used + * with a FALSE value for the 'enable_sequence' param. + * ('public elements' may be embedded in 'shadow Sequences') */ gdcmFile::gdcmFile(const char * filename, bool exception_on_error, diff --git a/src/gdcmParser.cxx b/src/gdcmParser.cxx index 056fb8e4..c84cbb28 100644 --- a/src/gdcmParser.cxx +++ b/src/gdcmParser.cxx @@ -44,11 +44,12 @@ const unsigned int gdcmParser::MAX_SIZE_PRINT_ELEMENT_VALUE = 64; /** * \brief constructor - * @param inFilename + * @param inFilename file to be opened for parsing * @param exception_on_error whether we throw an exception or not * @param enable_sequences = true to allow the header - * to be parsed *inside* the SeQuences, + * to be parsed *inside* the SeQuences, * when they have an actual length + * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files * @param ignore_shadow to allow skipping the shadow elements, * to save memory space. * \warning The TRUE value for this param has to be used