From: jpr Date: Tue, 1 Feb 2005 13:00:15 +0000 (+0000) Subject: Fix Doxygen warnings X-Git-Tag: Version1.0.bp~132 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=344736f50f507aa60d8fc6f6645fe5259a26b264;p=gdcm.git Fix Doxygen warnings --- diff --git a/Doc/Website/Support.html b/Doc/Website/Support.html index 66bfbf6f..b440eaf5 100644 --- a/Doc/Website/Support.html +++ b/Doc/Website/Support.html @@ -43,6 +43,7 @@ The contributors are
  • Jean-Michel Rouet
  • Peter Cech
  • Edouardo Davila +
  • Michal Kurgan diff --git a/src/gdcmDebug.cxx b/src/gdcmDebug.cxx index 855ef638..f9a9adde 100644 --- a/src/gdcmDebug.cxx +++ b/src/gdcmDebug.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDebug.cxx,v $ Language: C++ - Date: $Date: 2005/02/01 10:29:54 $ - Version: $Revision: 1.20 $ + Date: $Date: 2005/02/01 13:00:16 $ + Version: $Revision: 1.21 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -56,8 +56,9 @@ void Debug::SetDebugFlag (bool flag) } /** - * \brief Accessor + * \brief Gets the debug flag value * @param level Get the debug flag + * @return debug flag value */ bool Debug::GetDebugFlag () { @@ -66,7 +67,7 @@ bool Debug::GetDebugFlag () /** * \brief Accessor - * @param flag Set the debug flag to redirect to file + * @param flag whether we want to redirect to file */ void Debug::SetDebugToFile (bool flag) { @@ -74,8 +75,7 @@ void Debug::SetDebugToFile (bool flag) } /** - * \brief Accessor - * @param level Get the debug flag to redirect to file + * \brief Accessor to know if debug info are redirected to file */ bool Debug::GetDebugToFile () { diff --git a/src/gdcmDicomDir.cxx b/src/gdcmDicomDir.cxx index 34f7025c..f6582801 100644 --- a/src/gdcmDicomDir.cxx +++ b/src/gdcmDicomDir.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDicomDir.cxx,v $ Language: C++ - Date: $Date: 2005/02/01 10:34:59 $ - Version: $Revision: 1.124 $ + Date: $Date: 2005/02/01 13:00:16 $ + Version: $Revision: 1.125 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -570,6 +570,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type, // imageElem 0008 1155 "" // Referenced SOP Instance UID : to be set/forged later // imageElem fffe e00d "" // Item delimitation : length to be set to ZERO later // for all the relevant elements found in their own spot of the DicomDir.dic + // FIXME : troubles found when it's a SeqEntry for( it = elemList.begin(); it != elemList.end(); ++it) @@ -868,7 +869,8 @@ bool DicomDir::AddImageToEnd(DicomDirImage *dd) } /** - * \brief for each Header of the chained list, add/update the Patient/Study/Serie/Image info + * \brief for each Header of the chained list, + * add/update the Patient/Study/Serie/Image info * @param path path of the root directory * @param list chained list of Headers */ diff --git a/src/gdcmRLEFrame.cxx b/src/gdcmRLEFrame.cxx index 0b17ce09..99a7f718 100644 --- a/src/gdcmRLEFrame.cxx +++ b/src/gdcmRLEFrame.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmRLEFrame.cxx,v $ Language: C++ - Date: $Date: 2005/02/01 10:29:56 $ - Version: $Revision: 1.5 $ + Date: $Date: 2005/02/01 13:00:16 $ + Version: $Revision: 1.6 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -70,11 +70,9 @@ uint8_t *RLEFrame::ReadAndDecompressRLEFrame( uint8_t *subRaw, /** * \brief Implementation of the RLE decoding algorithm for decompressing * a RLE fragment. [refer to PS 3.5-2003, section G.3.2 p 86] - * @param subRaw Sub region of \ref Raw where the decoded fragment - * should be placed. + * @param subRaw Sub region where the decoded fragment should be placed. * @param fragmentSize The length of the binary fragment as found on the disk. - * @param RawSegmentSize The expected length of the fragment ONCE - * Raw. + * @param rawSegmentSize The expected length of the fragment ONCE Raw. * @param fp File Pointer: on entry the position should be the one of * the fragment to be decoded. */ diff --git a/src/gdcmRLEFramesInfo.cxx b/src/gdcmRLEFramesInfo.cxx index d95e93a5..b9337640 100644 --- a/src/gdcmRLEFramesInfo.cxx +++ b/src/gdcmRLEFramesInfo.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmRLEFramesInfo.cxx,v $ Language: C++ - Date: $Date: 2005/02/01 10:29:56 $ - Version: $Revision: 1.11 $ + Date: $Date: 2005/02/01 13:00:16 $ + Version: $Revision: 1.12 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -85,12 +85,14 @@ bool RLEFramesInfo::DecompressRLEFile( std::ifstream *fp , uint8_t *raw, int xSi } /** - * \brief Try to deal with RLE 16 Bits. - * We assume the RLE has already been parsed and loaded in - * Raw (through \ref ReadAndDecompressJPEGFile ). - * We here need to make 16 Bits Pixels from Low Byte and - * High Byte 'Planes'...(for what it may mean) - * @return Boolean + * \brief We assume Raw contains the decoded RLE pixels but as + * 8 bits per pixel. We convert those pixels to 16 bits + * per pixel. + * @param raw raw + * @param xSize x Size + * @param ySize y Size + * @param numberOfFrames number of frames + * @return Boolean always true */ bool RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits( uint8_t* raw, int xSize, int ySize,int numberOfFrames ) @@ -118,10 +120,10 @@ bool RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits( uint8_t* raw, int xSize, *(x++) = *(a++); } } - delete[] copyRaw; - + /// \todo check that operator new []didn't fail, and sometimes return false + return true; }