From: jpr Date: Thu, 6 Jan 2005 14:49:15 +0000 (+0000) Subject: Doxygenation X-Git-Tag: Version1.0.bp~473 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=baa2037ebb1ea642207f98a099306b3e9fd7d9f4;p=gdcm.git Doxygenation --- diff --git a/Dicts/dicomTS.dic b/Dicts/dicomTS.dic index 284befe5..5376fafc 100644 --- a/Dicts/dicomTS.dic +++ b/Dicts/dicomTS.dic @@ -18,7 +18,7 @@ 1.2.840.10008.1.2.4.63 JPEG Full Progression, Hierarchical (Process 24 & 26) (Retired) 1.2.840.10008.1.2.4.64 JPEG Full Progression, Hierarchical (Process 25 & 27) (Retired) 1.2.840.10008.1.2.4.65 JPEG Lossless, Hierarchical (Process 28) (Retired) -1.2.840.10008.1.2.4.66 JPEG Lossless, Hierarchical (Process 29) (Retired)) +1.2.840.10008.1.2.4.66 JPEG Lossless, Hierarchical (Process 29) (Retired) 1.2.840.10008.1.2.4.70 JPEG Lossless, Non-Hierarchical, First-Order Prediction (Process 14 [Selection Value 1]) 1.2.840.10008.1.2.4.80 JPEG-LS Lossless Image Compression 1.2.840.10008.1.2.4.81 JPEG-LS Lossy (Near-Lossless) Image Compression diff --git a/Dicts/dicomV3.dic b/Dicts/dicomV3.dic index 83a6b238..dcaf0ee3 100644 --- a/Dicts/dicomV3.dic +++ b/Dicts/dicomV3.dic @@ -2200,7 +2200,7 @@ 600e 3000 OW OLY Overlay Data 600e 4000 LO OLY Comments (RET) 7fe0 0000 UL PXL Group Length -7fe0 0010 OB PXL Pixel Data +7fe0 0010 OW PXL Pixel Data fffa fffa SQ XX Digital Signatures Sequence fffc fffc OB XX Data Set Trailing Padding fffe e000 UL DL Item diff --git a/Testing/TestCopyDicom.cxx b/Testing/TestCopyDicom.cxx index 79825ae0..3a869912 100644 --- a/Testing/TestCopyDicom.cxx +++ b/Testing/TestCopyDicom.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: TestCopyDicom.cxx,v $ Language: C++ - Date: $Date: 2004/12/07 18:16:39 $ - Version: $Revision: 1.26 $ + Date: $Date: 2005/01/06 14:49:15 $ + 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 @@ -131,7 +131,7 @@ int CopyDicom(std::string const & filename, if( !copy->WriteDcmExplVR(output) ) { std::cout << " Failed" << std::endl - << " " << output << " not written" << std::endl; + << " " << output << " not written" << std::endl; delete original; delete copy; diff --git a/src/gdcmDocument.cxx b/src/gdcmDocument.cxx index f1322ac5..2cc0770d 100644 --- a/src/gdcmDocument.cxx +++ b/src/gdcmDocument.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.cxx,v $ Language: C++ - Date: $Date: 2005/01/06 13:35:38 $ - Version: $Revision: 1.155 $ + Date: $Date: 2005/01/06 14:49:16 $ + Version: $Revision: 1.156 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -535,7 +535,7 @@ void Document::WriteContent(std::ofstream* fp, FileType filetype) } /** - * \brief Modifies the value of a given Header Entry (Dicom Element) + * \brief Modifies the value of a given Doc Entry (Dicom Element) * when it exists. Create it with the given value when unexistant. * @param value (string) Value to be set * @param group Group number of the Entry @@ -627,6 +627,7 @@ ValEntry* Document::ReplaceOrCreateByNumber( * @param binArea (binary) value to be set * @param Group Group number of the Entry * @param Elem Element number of the Entry + * @param vr V(alue) R(epresentation) of the Entry -if private Entry- * \return pointer to the modified/created Header Entry (NULL when creation * failed). */ diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index f9780b8b..395f8bd2 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmFile.cxx,v $ Language: C++ - Date: $Date: 2005/01/06 08:46:21 $ - Version: $Revision: 1.180 $ + Date: $Date: 2005/01/06 14:49:16 $ + Version: $Revision: 1.181 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -407,7 +407,8 @@ bool File::WriteDcmImplVR (std::string const & fileName) /** * \brief Writes on disk A SINGLE Dicom file, * using the Explicit Value Representation convention - * NO test is performed on processor "Endiannity". * @param fileName name of the file to be created + * NO test is performed on processor "Endiannity". + * @param fileName name of the file to be created * (any already existing file is overwritten) * @return false if write fails */ @@ -510,24 +511,61 @@ bool File::Write(std::string const& fileName) return check; } +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (string) to substitute with + * @param group group number of the Dicom Element to modify + * @param element element number of the Dicom Element to modify + */ bool File::SetEntryByNumber(std::string const& content, uint16_t group, uint16_t element) { return HeaderInternal->SetEntryByNumber(content,group,element); } + +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (void* -> uint8_t*) to substitute with + * @param lgth new value length + * @param group group number of the Dicom Element to modify + * @param element element number of the Dicom Element to modify + */ bool File::SetEntryByNumber(uint8_t* content, int lgth, uint16_t group, uint16_t element) { return HeaderInternal->SetEntryByNumber(content,lgth,group,element); } +/** + * \brief Modifies the value of a given Doc Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * @param value (string) Value to be set + * @param group Group number of the Entry + * @param elem Element number of the Entry + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ bool File::ReplaceOrCreateByNumber(std::string const& content, uint16_t group, uint16_t element) { return HeaderInternal->ReplaceOrCreateByNumber(content,group,element) != NULL; } +/* + * \brief Modifies the value of a given Header Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * A copy of the binArea is made to be kept in the Document. + * @param binArea (binary) value to be set + * @param Group Group number of the Entry + * @param Elem Element number of the Entry + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ bool File::ReplaceOrCreateByNumber(uint8_t* binArea, int lgth, uint16_t group, uint16_t element) {