From 8fa22a939771f727812c725d99ea5b75f56f0c71 Mon Sep 17 00:00:00 2001 From: jpr Date: Mon, 28 Jun 2004 16:00:18 +0000 Subject: [PATCH] Doxygenation --- src/gdcmDocument.cxx | 7 ++++--- src/gdcmDocument.h | 8 ++++---- src/gdcmFile.cxx | 10 +++++----- src/gdcmHeader.cxx | 6 +++--- 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/src/gdcmDocument.cxx b/src/gdcmDocument.cxx index 53bfa005..5aa18c28 100644 --- a/src/gdcmDocument.cxx +++ b/src/gdcmDocument.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.cxx,v $ Language: C++ - Date: $Date: 2004/06/28 14:29:52 $ - Version: $Revision: 1.39 $ + Date: $Date: 2004/06/28 16:00:18 $ + Version: $Revision: 1.40 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -706,7 +706,7 @@ int gdcmDocument::CheckIfEntryExistByNumber(guint16 group, guint16 element ) { * @return Corresponding element value when it exists, * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -std::string gdcmDocument::GetEntryByName(std::string tagName) { +std::string gdcmDocument::GetEntryByName(TagName tagName) { gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); if( dictEntry == NULL) return GDCM_UNFOUND; @@ -846,6 +846,7 @@ bool gdcmDocument::SetEntryByNumber(std::string content, * through it's (group, element) and modifies it's content with * the given value. * @param content new value (void *) 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 */ diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index 6b757e27..de79bf44 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.h,v $ Language: C++ - Date: $Date: 2004/06/28 09:30:58 $ - Version: $Revision: 1.17 $ + Date: $Date: 2004/06/28 16:00:18 $ + Version: $Revision: 1.18 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -249,10 +249,10 @@ public: /// Accessor to \ref printLevel inline void SetPrintLevel(int level) { printLevel = level; } - /// Accessor to \ref filename + /// Accessor to \ref Filename inline std::string &GetFileName() { return Filename; } - /// Accessor to \ref filename + /// Accessor to \ref Filename inline void SetFileName(const char* fileName) { Filename = fileName; } /// Accessor to \ref gdcmElementSet::tagHT diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index 7da9762c..ec0eb7d3 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmFile.cxx,v $ Language: C++ - Date: $Date: 2004/06/28 14:29:52 $ - Version: $Revision: 1.113 $ + Date: $Date: 2004/06/28 16:00:18 $ + Version: $Revision: 1.114 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -244,7 +244,7 @@ void *gdcmFile::GetImageData() * * @param destination Address (in caller's memory space) at which the * pixel data should be copied - * @param MaxSize Maximum number of bytes to be copied. When MaxSize + * @param maxSize Maximum number of bytes to be copied. When MaxSize * is not sufficient to hold the pixel data the copy is not * executed (i.e. no partial copy). * @return On success, the number of bytes actually copied. Zero on @@ -366,7 +366,7 @@ void * gdcmFile::GetImageDataRaw () * * @param destination Address (in caller's memory space) at which the * pixel data should be copied - * @param MaxSize Maximum number of bytes to be copied. When MaxSize + * @param maxSize Maximum number of bytes to be copied. When MaxSize * is not sufficient to hold the pixel data the copy is not * executed (i.e. no partial copy). * @return On success, the number of bytes actually copied. Zero on @@ -635,7 +635,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void *destination, size_t maxSize) * 'volume'Pixels are presented as C-like 3D arrays : lane per plane * \warning user is kindly requested NOT TO 'free' the Pixel area * @param inData user supplied pixel area - * @param ExpectedSize total image size, in Bytes + * @param expectedSize total image size, in Bytes * * @return boolean */ diff --git a/src/gdcmHeader.cxx b/src/gdcmHeader.cxx index 40ff3bfb..0dc8ef97 100644 --- a/src/gdcmHeader.cxx +++ b/src/gdcmHeader.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmHeader.cxx,v $ Language: C++ - Date: $Date: 2004/06/28 14:29:52 $ - Version: $Revision: 1.173 $ + Date: $Date: 2004/06/28 16:00:18 $ + Version: $Revision: 1.174 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -29,7 +29,7 @@ // Constructor / Destructor /** * \brief Constructor - * @param InFilename name of the file whose header we want to analyze + * @param filename name of the file whose header we want to analyze * @param exception_on_error whether we want to 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 -- 2.48.1