From: jpr Date: Fri, 19 Mar 2004 15:54:54 +0000 (+0000) Subject: some more doxygenation X-Git-Tag: Version0.5.bp~285 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=eb835becc89cc1b8a1dc1f122f54b7659a6127be;p=gdcm.git some more doxygenation --- diff --git a/src/gdcmDicomDir.cxx b/src/gdcmDicomDir.cxx index 2939043f..e6a3d042 100644 --- a/src/gdcmDicomDir.cxx +++ b/src/gdcmDicomDir.cxx @@ -64,7 +64,7 @@ gdcmDicomDir::gdcmDicomDir(const char *Name, bool parseDir, if(strlen(Name)==1 && Name[0]=='.') { // user passed '.' as Name // we get current directory name - char*dummy=(char*) malloc(1000); // TODO : check with Windoze + char*dummy=(char*) malloc(1000); // TODO : check with Windoze // JPR getcwd(dummy,(size_t)1000); SetFileName(dummy); // will be converted into a string free(dummy); // no longer needed @@ -78,9 +78,10 @@ gdcmDicomDir::gdcmDicomDir(const char *Name, bool parseDir, } else { CreateDicomDir(); - CheckBoundaries(); // JPR - } - + CheckBoundaries(); // to maintain consistency between + // home-made gdcmDicomDir + // and the ones comming from a DICOMDIR file + } } /* @@ -297,7 +298,7 @@ bool gdcmDicomDir::Write(std::string fileName) fwrite(filePreamble,128,1,fp1); fwrite("DICM",4,1,fp1); free(filePreamble); - //UpdateDirectoryRecordSequenceLength(); // a reecrire en utilisant + //UpdateDirectoryRecordSequenceLength(); // a reecrire en utilisant JPR // la structure arborescente JPR WriteDicomDirEntries(fp1); diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h index 6a0e9410..2c9a561e 100644 --- a/src/gdcmDicomDirElement.h +++ b/src/gdcmDicomDirElement.h @@ -42,8 +42,6 @@ public: * \sa SetPrintLevel */ void Print(std::ostream &os); - - /** * \ingroup gdcmDicomDirElement * \brief returns a reference to the chained List diff --git a/src/gdcmDicomDirSerie.cxx b/src/gdcmDicomDirSerie.cxx index 1571d28d..0c0caf0f 100644 --- a/src/gdcmDicomDirSerie.cxx +++ b/src/gdcmDicomDirSerie.cxx @@ -7,7 +7,7 @@ // Constructor / Destructor /** * \ingroup gdcmDicomDirSerie - * \brief + * \brief Constructor * @param begin iterator (inside the gdcmParser chained list) * on the first Header Entry (i.e Dicom Element) * related to this "SERIE" part diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index feca2933..176b2c8c 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -95,7 +95,7 @@ gdcmFile::~gdcmFile(void) { // Public /** * \ingroup gdcmFile - * \brief + * \brief returns the gdcmHeader *Header * @return */ gdcmHeader *gdcmFile::GetHeader(void) { @@ -403,7 +403,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) { return (size_t)0; } } -// DO NOT remove this code commented out. +// DO NOT remove this commented out code . // Nobody knows what's expecting you ... // Just to 'see' what was actually read on disk :-( diff --git a/src/gdcmObject.cxx b/src/gdcmObject.cxx index a067e72b..5bbe38bb 100644 --- a/src/gdcmObject.cxx +++ b/src/gdcmObject.cxx @@ -44,7 +44,6 @@ gdcmObject::~gdcmObject(void) { void gdcmObject::Print(std::ostream &os) { if(printLevel>=0) { ListTag::iterator i; - //for(ListTag::iterator i=beginObj;i!=endObj;++i) // JPR for(i=beginObj;;++i) { (*i)->SetPrintLevel(printLevel); (*i)->Print(os); @@ -61,7 +60,6 @@ void gdcmObject::Print(std::ostream &os) { * @return */ std::string gdcmObject::GetEntryByNumber(guint16 group, guint16 element) { - //for(ListTag::iterator i=beginObj;i!=endObj;++i) // JPR for(ListTag::iterator i=beginObj;;++i) { if ( (*i)->GetGroup()==group && (*i)->GetElement()==element) return (*i)->GetValue(); @@ -180,7 +178,6 @@ void gdcmObject::ResetBoundaries(int flag) { */ TagHeaderEntryHT gdcmObject::GetEntry(void) { TagHeaderEntryHT HT; - //for(ListTag::iterator i=beginObj;i!=endObj;++i) // JPR for(ListTag::iterator i=beginObj;;++i) { HT.insert( PairHT( (*i)->GetKey(),(*i)) ); if (i == endObj) break; @@ -197,7 +194,6 @@ TagHeaderEntryHT gdcmObject::GetEntry(void) { */ ListTag gdcmObject::GetListEntry(void) { ListTag list; - //for(ListTag::iterator i=beginObj;i!=endObj;++i) // JPR for(ListTag::iterator i=beginObj;;++i) { list.push_back(*i); if (i == endObj) break; @@ -229,7 +225,7 @@ void gdcmObject::FillObject(std::list elemList) { tmpEl=it->elem; dictEntry=gdcmGlobal::GetDicts()->GetDefaultPubDict()->GetDictEntryByNumber(tmpGr,tmpEl); entry=new gdcmHeaderEntry(dictEntry); - entry->SetOffset(0); // just to avoid missprinting //JPR + entry->SetOffset(0); // just to avoid further missprinting entry->SetValue(it->value); if(dictEntry->GetGroup()==0xfffe) @@ -253,7 +249,7 @@ void gdcmObject::FillObject(std::list elemList) { entry->SetLength(entry->GetValue().length()); } ptagHT->insert( PairHT(entry->GetKey(),entry) ); // add in the (multimap) H Table - plistEntries->insert(debInsertion ,entry); // en tete de liste des Patients + plistEntries->insert(debInsertion ,entry); // add at the begining of the Patient list ++finInsertion; } diff --git a/src/gdcmObject.h b/src/gdcmObject.h index 2d49cf3b..f4823553 100644 --- a/src/gdcmObject.h +++ b/src/gdcmObject.h @@ -21,7 +21,13 @@ public: TagHeaderEntryHT *ptagHT, ListTag *plistEntries); ~gdcmObject(void); - void SetPrintLevel(int level) { printLevel = level; }; + /** + * \ingroup gdcmParser + * \brief Sets the print level for the Dicom Header + * \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy + */ + void SetPrintLevel(int level) + { printLevel = level; }; virtual void Print(std::ostream &os = std::cout); std::string GetEntryByNumber(guint16 group, guint16 element); diff --git a/src/gdcmParser.cxx b/src/gdcmParser.cxx index 03fdde5d..b01eea12 100644 --- a/src/gdcmParser.cxx +++ b/src/gdcmParser.cxx @@ -1474,7 +1474,7 @@ void gdcmParser::LoadHeaderEntry(gdcmHeaderEntry *Entry) { } if( (vr == "UI") ) // Because of correspondance with the VR dic - Entry->SetValue(NewValue.c_str()); // ??? JPR ??? + Entry->SetValue(NewValue.c_str()); else Entry->SetValue(NewValue); } @@ -2407,7 +2407,7 @@ gdcmHeaderEntry *gdcmParser::ReadNextHeaderEntry(void) { /* Pb : how to propagate the element length (used in SkipHeaderEntry) // direct call to SkipBytes ? - if (ignoreShadow == 1 && g%2 ==1) //JPR + if (ignoreShadow == 1 && g%2 ==1) // if user wants to skip shadow groups // and current element *is* a shadow element // we don't create anything