From 038a3b7f67769dc20b4c46f3c9dcad7cc63d1161 Mon Sep 17 00:00:00 2001 From: jpr Date: Tue, 18 Jan 2005 08:01:40 +0000 Subject: [PATCH] 2005-01-18 Jean-Pierre Roux remove useless and never updated keyword \ingroup --- src/gdcmDictSet.cxx | 10 ++++----- src/gdcmDirList.cxx | 10 ++++----- src/gdcmDocEntry.cxx | 13 +++--------- src/gdcmDocument.cxx | 9 +++----- src/gdcmDocument.h | 12 +++++------ src/gdcmElementSet.cxx | 27 ++++++++++++------------ src/gdcmElementSet.h | 11 +++------- src/gdcmException.cxx | 16 ++++++-------- src/gdcmGlobal.cxx | 15 ++------------ src/gdcmJpeg.cxx | 5 ++--- src/gdcmSQItem.cxx | 8 +++---- src/gdcmSeqEntry.cxx | 5 ++--- src/gdcmSerieHeader.cxx | 7 ++----- src/gdcmTS.cxx | 5 ++--- src/gdcmUtil.cxx | 46 +++++++++++++++++++++++++++-------------- 15 files changed, 87 insertions(+), 112 deletions(-) diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index f8bb4f35..c825df10 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDictSet.cxx,v $ Language: C++ - Date: $Date: 2005/01/18 07:50:58 $ - Version: $Revision: 1.52 $ + Date: $Date: 2005/01/18 08:01:40 $ + Version: $Revision: 1.53 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -43,7 +43,7 @@ DictSet::DictSet() */ DictSet::~DictSet() { - // Remove dictionnaries + // Remove dictionaries for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag) { Dict *entryToDelete = tag->second; @@ -195,10 +195,10 @@ DictEntry *DictSet::NewVirtualDictEntry( uint16_t group, /** * \brief Obtain from the GDCM_DICT_PATH environnement variable the - * path to directory containing the dictionnaries. When + * path to directory containing the dictionaries. When * the environnement variable is absent the path is defaulted * to "../Dicts/". - * @return path to directory containing the dictionnaries + * @return path to directory containing the dictionaries */ std::string DictSet::BuildDictPath() { diff --git a/src/gdcmDirList.cxx b/src/gdcmDirList.cxx index 3362843a..4422a0a8 100644 --- a/src/gdcmDirList.cxx +++ b/src/gdcmDirList.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDirList.cxx,v $ Language: C++ - Date: $Date: 2005/01/14 23:51:40 $ - Version: $Revision: 1.38 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.39 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -34,7 +34,6 @@ namespace gdcm { // Constructor / Destructor /** - * \ingroup DirList * \brief Constructor * @param dirName root directory name * @param recursive whether we want to explore recursively or not @@ -46,7 +45,6 @@ DirList::DirList(std::string const &dirName, bool recursive) } /** - * \ingroup DirList * \brief Destructor */ DirList::~DirList() @@ -57,8 +55,8 @@ DirList::~DirList() // Public /** - * \ingroup DirList * \brief Print method + * @param os ostream to write to */ void DirList::Print(std::ostream &os) { @@ -119,7 +117,7 @@ int DirList::Explore(std::string const &dirpath, bool recursive) // According to POSIX, the dirent structure contains a field char d_name[] // of unspecified size, with at most NAME_MAX characters preceding the - // terminating null character. Use of other fields will harm the porta- + // terminating null character. Use of other fields will harm the porta- // bility of your programs. struct stat buf; diff --git a/src/gdcmDocEntry.cxx b/src/gdcmDocEntry.cxx index 9021e931..a1718533 100644 --- a/src/gdcmDocEntry.cxx +++ b/src/gdcmDocEntry.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocEntry.cxx,v $ Language: C++ - Date: $Date: 2005/01/16 04:50:41 $ - Version: $Revision: 1.41 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.42 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -35,7 +35,6 @@ namespace gdcm //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup DocEntry * \brief Constructor from a given DictEntry * @param in Pointer to existing dictionary entry */ @@ -54,7 +53,6 @@ DocEntry::DocEntry(DictEntry *in) //----------------------------------------------------------------------------- // Print /** - * \ingroup DocEntry * \brief Prints the common part of ValEntry, BinEntry, SeqEntry * @param os ostream we want to print in */ @@ -116,7 +114,6 @@ void DocEntry::Print(std::ostream &os, std::string const & ) } /** - * \ingroup DocEntry * \brief Writes the common part of any ValEntry, BinEntry, SeqEntry * @param fp already open file pointer * @param filetype type of the file to be written @@ -216,7 +213,6 @@ void DocEntry::WriteContent(std::ofstream *fp, FileType filetype) // Public /** - * \ingroup DocEntry * \brief Gets the full length of the elementary DocEntry (not only value * length) depending on the VR. */ @@ -242,8 +238,8 @@ uint32_t DocEntry::GetFullLength() } /** - * \ingroup DocEntry * \brief Copies all the attributes from an other DocEntry + * @param e entry to copy from */ void DocEntry::Copy (DocEntry *e) { @@ -251,11 +247,9 @@ void DocEntry::Copy (DocEntry *e) ReadLength = e->ReadLength; ImplicitVR = e->ImplicitVR; Offset = e->Offset; - // TODO : remove DocEntry SQDepth } /** - * \ingroup DocEntry * \brief tells us if entry is the last one of a 'no length' SequenceItem * (fffe,e00d) */ @@ -264,7 +258,6 @@ bool DocEntry::IsItemDelimitor() return (GetGroup() == 0xfffe && GetElement() == 0xe00d); } /** - * \ingroup DocEntry * \brief tells us if entry is the last one of a 'no length' Sequence * (fffe,e0dd) */ diff --git a/src/gdcmDocument.cxx b/src/gdcmDocument.cxx index ddc83e57..73486bc7 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/17 17:31:01 $ - Version: $Revision: 1.194 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.195 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -2977,10 +2977,7 @@ int Document::ComputeGroup0002Length( FileType filetype ) bool found0002 = false; // for each zero-level Tag in the DCM Header - DocEntry *entry; - - InitTraversal(); - entry = GetNextEntry(); + DocEntry *entry = GetFirstEntry(); while(entry) { gr = entry->GetGroup(); diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index a504c596..8a7bce38 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.h,v $ Language: C++ - Date: $Date: 2005/01/17 16:52:21 $ - Version: $Revision: 1.88 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.89 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -48,13 +48,11 @@ public: FileType GetFileType(); std::string GetTransferSyntax(); - - bool IsDicomV3(); - + RLEFramesInfo *GetRLEInfo() { return RLEInfo; } JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; } -// Dictionnaries +// Dictionaries virtual void PrintPubDict (std::ostream &os = std::cout); virtual void PrintShaDict (std::ostream &os = std::cout); @@ -127,6 +125,8 @@ public: /// Return the Transfer Syntax as a string std::string GetTransferSyntaxName(); + bool IsDicomV3(); + protected: // Methods // Constructor and destructor are protected to forbid end user diff --git a/src/gdcmElementSet.cxx b/src/gdcmElementSet.cxx index afabc9af..769c7814 100644 --- a/src/gdcmElementSet.cxx +++ b/src/gdcmElementSet.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmElementSet.cxx,v $ Language: C++ - Date: $Date: 2005/01/16 04:50:41 $ - Version: $Revision: 1.42 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.43 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -28,7 +28,6 @@ namespace gdcm //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup ElementSet * \brief Constructor from a given ElementSet */ //BOZ depthLevel is not usefull anymore @@ -39,7 +38,6 @@ ElementSet::ElementSet(int depthLevel) } /** - * \ingroup ElementSet * \brief Canonical destructor. */ ElementSet::~ElementSet() @@ -59,6 +57,7 @@ ElementSet::~ElementSet() /** * \brief Prints the Header Entries (Dicom Elements) * from the H Table + * @param os ostream to write to * @return */ void ElementSet::Print(std::ostream &os, std::string const & ) @@ -70,9 +69,9 @@ void ElementSet::Print(std::ostream &os, std::string const & ) entry->SetPrintLevel(PrintLevel); entry->Print(os); - if ( SeqEntry *seqEntry = dynamic_cast(entry) ) + if ( /*SeqEntry *seqEntry = */dynamic_cast(entry) ) { - (void)seqEntry; + //(void)seqEntry; // Avoid the newline for a sequence: continue; } @@ -85,6 +84,7 @@ void ElementSet::Print(std::ostream &os, std::string const & ) /** * \brief Writes the Header Entries (Dicom Elements) * from the H Table + * @param os ostream to write to * @return */ void ElementSet::WriteContent(std::ofstream *fp, FileType filetype) @@ -126,8 +126,6 @@ bool ElementSet::AddEntry(DocEntry *newEntry) /** * \brief Clear the hash table from given entry AND delete the entry. * @param entryToRemove Entry to remove AND delete. - * \warning Some problems when using under Windows... prefer the use of - * Initialize / GetNext methods */ bool ElementSet::RemoveEntry( DocEntry *entryToRemove) { @@ -135,7 +133,7 @@ bool ElementSet::RemoveEntry( DocEntry *entryToRemove) if( TagHT.count(key) == 1 ) { TagHT.erase(key); - gdcmVerboseMacro( "One element erased."); + //gdcmVerboseMacro( "One element erased."); delete entryToRemove; return true; } @@ -154,7 +152,7 @@ bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove) if( TagHT.count(key) == 1 ) { TagHT.erase(key); - gdcmVerboseMacro( "One element erased."); + //gdcmVerboseMacro( "One element erased."); return true; } @@ -163,15 +161,18 @@ bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove) } /** - * \brief Initialise the visit of the Hash table (TagHT) + * \brief Get the first entry while visiting the DocEntrySet + * \return The first DocEntry if found, otherwhise NULL */ -void ElementSet::InitTraversal() +DocEntry *ElementSet::GetFirstEntry() { ItTagHT = TagHT.begin(); + return ItTagHT->second; } /** - * \brief Get the next entry whil visiting the Hash table (TagHT) + * \brief Get the next entry while visiting the Hash table (TagHT) + * \note : meaningfull only if GetFirstEntry already called * \return The next DocEntry if found, otherwhise NULL */ DocEntry *ElementSet::GetNextEntry() diff --git a/src/gdcmElementSet.h b/src/gdcmElementSet.h index 7a4e5124..3bd508c7 100644 --- a/src/gdcmElementSet.h +++ b/src/gdcmElementSet.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmElementSet.h,v $ Language: C++ - Date: $Date: 2005/01/16 04:50:41 $ - Version: $Revision: 1.31 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.32 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -54,13 +54,8 @@ public: bool RemoveEntryNoDestroy(DocEntry *EntryToRemove); void WriteContent(std::ofstream *fp, FileType filetype); - - /// Accessor to \ref TagHT - // Do not expose this to user (public API) ! - // A test is using it thus put it in public (matt) - //TagDocEntryHT const &GetTagHT() const { return TagHT; }; - void InitTraversal(); + DocEntry *GetFirstEntry(); DocEntry *GetNextEntry(); protected: diff --git a/src/gdcmException.cxx b/src/gdcmException.cxx index 21184b78..471bc41e 100644 --- a/src/gdcmException.cxx +++ b/src/gdcmException.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmException.cxx,v $ Language: C++ - Date: $Date: 2005/01/06 20:03:27 $ - Version: $Revision: 1.23 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.24 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -26,10 +26,9 @@ namespace gdcm // Exception /** - * \ingroup Exception * \brief constructor - * @param f - * @param msg + * @param f f + * @param msg msg */ Exception::Exception(const std::string &f, const std::string &msg) throw() #ifdef __GNUC__ @@ -45,9 +44,8 @@ catch(...) { /** - * \ingroup Exception * \brief fatal - * @param from + * @param from from */ void Exception::fatal(const char *from) throw() { try @@ -72,7 +70,6 @@ void Exception::fatal(const char *from) throw() { } /** - * \ingroup Exception * \brief getName * @return string */ @@ -113,7 +110,6 @@ std::string Exception::getName() const throw() } /** - * \ingroup Exception * \brief Exception */ Exception::operator const char *() const throw() { @@ -122,8 +118,8 @@ std::string Exception::getName() const throw() //----------------------------------------------------------------------------- /** - * \ingroup Exception * \brief Exception::operator << + * @param os ostream to write to */ std::ostream& operator<<(std::ostream &os, const Exception &e) { try { diff --git a/src/gdcmGlobal.cxx b/src/gdcmGlobal.cxx index 4120c2a6..a3a46599 100644 --- a/src/gdcmGlobal.cxx +++ b/src/gdcmGlobal.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmGlobal.cxx,v $ Language: C++ - Date: $Date: 2005/01/11 11:37:14 $ - Version: $Revision: 1.14 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.15 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -39,39 +39,33 @@ const std::string GDCM_NOTLOADED = "gdcm::NotLoaded"; const std::string GDCM_UNREAD = "gdcm::UnRead"; /** - * \ingroup Globals * \brief Pointer to a container, holding _all_ the Dicom Dictionaries. */ DictSet *Global::Dicts = (DictSet *)0; /** - * \ingroup Globals * \brief Pointer to a hash table containing the 'Value Representations'. */ VR *Global::ValRes = (VR *)0; /** - * \ingroup Globals * \brief Pointer to a hash table containing the Transfer Syntax codes * and their english description */ TS *Global::TranSyn = (TS *)0; /** - * \ingroup Globals * \brief Pointer to the hash table containing the Dicom Elements * necessary to describe each part of a DICOMDIR */ DicomDirElement *Global::ddElem = (DicomDirElement *)0; /** - * \ingroup Globals * \brief Global container */ Global Glob; /** - * \ingroup Global * \brief constructor : populates the various H Tables */ Global::Global() @@ -88,7 +82,6 @@ Global::Global() } /** - * \ingroup Global * \brief canonical destructor */ Global::~Global() @@ -99,7 +92,6 @@ Global::~Global() delete ddElem; } /** - * \ingroup Global * \brief returns a pointer to the 'Value Representation Table' */ VR *Global::GetVR() @@ -107,7 +99,6 @@ VR *Global::GetVR() return ValRes; } /** - * \ingroup Global * \brief returns a pointer to the 'Transfer Syntax Table' */ TS *Global::GetTS() @@ -115,7 +106,6 @@ TS *Global::GetTS() return TranSyn; } /** - * \ingroup Global * \brief returns a pointer to Dictionaries Table */ DictSet *Global::GetDicts() @@ -123,7 +113,6 @@ DictSet *Global::GetDicts() return Dicts; } /** - * \ingroup Global * \brief returns a pointer to the DicomDir related elements Table */ DicomDirElement *Global::GetDicomDirElements() diff --git a/src/gdcmJpeg.cxx b/src/gdcmJpeg.cxx index 9749edd9..28f58b3f 100644 --- a/src/gdcmJpeg.cxx +++ b/src/gdcmJpeg.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmJpeg.cxx,v $ Language: C++ - Date: $Date: 2005/01/12 19:02:13 $ - Version: $Revision: 1.31 $ + Date: $Date: 2005/01/18 08:01:41 $ + Version: $Revision: 1.32 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -127,7 +127,6 @@ namespace gdcm */ /** - * \ingroup File * \brief routine for JPEG decompression * @param fp pointer to an already open file descriptor * 8 significant bits per pixel diff --git a/src/gdcmSQItem.cxx b/src/gdcmSQItem.cxx index 8f0c59eb..4717dcb0 100644 --- a/src/gdcmSQItem.cxx +++ b/src/gdcmSQItem.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmSQItem.cxx,v $ Language: C++ - Date: $Date: 2005/01/17 11:07:40 $ - Version: $Revision: 1.52 $ + Date: $Date: 2005/01/18 08:01:42 $ + Version: $Revision: 1.53 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -32,7 +32,6 @@ namespace gdcm //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup SQItem * \brief Constructor from a given SQItem */ SQItem::SQItem(int depthLevel ) @@ -95,7 +94,6 @@ void SQItem::Print(std::ostream &os, std::string const &) } /* - * \ingroup SQItem * \brief canonical Writer */ void SQItem::WriteContent(std::ofstream *fp, FileType filetype) @@ -276,7 +274,7 @@ void SQItem::Initialize() } /** - * \brief Get the next entry whil visiting the chained list + * \brief Get the next entry while visiting the chained list * \return The next DocEntry if found, otherwhise NULL */ DocEntry *SQItem::GetNextEntry() diff --git a/src/gdcmSeqEntry.cxx b/src/gdcmSeqEntry.cxx index a0fc0bcf..59404d03 100644 --- a/src/gdcmSeqEntry.cxx +++ b/src/gdcmSeqEntry.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmSeqEntry.cxx,v $ Language: C++ - Date: $Date: 2005/01/17 11:13:21 $ - Version: $Revision: 1.44 $ + Date: $Date: 2005/01/18 08:01:42 $ + Version: $Revision: 1.45 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -33,7 +33,6 @@ namespace gdcm //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup SeqEntry * \brief Constructor from a given SeqEntry */ SeqEntry::SeqEntry( DictEntry *e ) diff --git a/src/gdcmSerieHeader.cxx b/src/gdcmSerieHeader.cxx index e1347e26..05f2ecef 100644 --- a/src/gdcmSerieHeader.cxx +++ b/src/gdcmSerieHeader.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmSerieHeader.cxx,v $ Language: C++ - Date: $Date: 2005/01/14 22:20:11 $ - Version: $Revision: 1.9 $ + Date: $Date: 2005/01/18 08:01:42 $ + Version: $Revision: 1.10 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -135,7 +135,6 @@ void SerieHeader::OrderGdcmFileList() //----------------------------------------------------------------------------- // Private /** - * \ingroup Header * \brief sorts the images, according to their Patient Position * We may order, considering : * -# Image Number @@ -257,7 +256,6 @@ bool SerieHeader::ImagePositionPatientOrdering() } /** - * \ingroup Header * \brief sorts the images, according to their Image Number * @return false only if the header is bugged ! */ @@ -320,7 +318,6 @@ bool SerieHeader::ImageNumberOrdering() /** - * \ingroup Header * \brief sorts the images, according to their File Name * @return false only if the header is bugged ! */ diff --git a/src/gdcmTS.cxx b/src/gdcmTS.cxx index d61ca287..392cc548 100644 --- a/src/gdcmTS.cxx +++ b/src/gdcmTS.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmTS.cxx,v $ Language: C++ - Date: $Date: 2005/01/11 23:16:47 $ - Version: $Revision: 1.36 $ + Date: $Date: 2005/01/18 08:01:42 $ + Version: $Revision: 1.37 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -110,7 +110,6 @@ TS::~TS() //----------------------------------------------------------------------------- // Print /** - * \ingroup VR * \brief Print all * @param os The output stream to be written to. */ diff --git a/src/gdcmUtil.cxx b/src/gdcmUtil.cxx index f0b9def9..1b7462cc 100644 --- a/src/gdcmUtil.cxx +++ b/src/gdcmUtil.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmUtil.cxx,v $ Language: C++ - Date: $Date: 2005/01/17 23:11:25 $ - Version: $Revision: 1.109 $ + Date: $Date: 2005/01/18 08:01:42 $ + Version: $Revision: 1.110 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -75,7 +75,6 @@ namespace gdcm { /** - * \ingroup Globals * \brief Provide a better 'c++' approach for sprintf * For example c code is: * sprintf(trash, "%04x|%04x", group , elem); @@ -105,7 +104,6 @@ std::string Util::Format(const char *format, ...) /** - * \ingroup Globals * \brief Because not available in C++ (?) */ void Util::Tokenize (const std::string &str, @@ -123,7 +121,6 @@ void Util::Tokenize (const std::string &str, } /** - * \ingroup Globals * \brief Because not available in C++ (?) * Counts the number of occurences of a substring within a string */ @@ -149,7 +146,6 @@ int Util::CountSubstring (const std::string &str, } /** - * \ingroup Globals * \brief Weed out a string from the non-printable characters (in order * to avoid corrupting the terminal of invocation when printing) * @param s string to remove non printable characters from @@ -181,7 +177,6 @@ std::string Util::CreateCleanString(std::string const &s) } /** - * \ingroup Globals * \brief Add a SEPARATOR to the end of the name is necessary * @param pathname file/directory name to normalize */ @@ -201,7 +196,6 @@ std::string Util::NormalizePath(std::string const &pathname) } /** - * \ingroup Globals * \brief Get the (directory) path from a full path file name * @param fullName file/directory name to extract Path from */ @@ -223,7 +217,6 @@ std::string Util::GetPath(std::string const &fullName) } /** - * \ingroup Util * \brief Get the (last) name of a full path file name * @param fullName file/directory name to extract end name from */ @@ -245,7 +238,6 @@ std::string Util::GetName(std::string const &fullName) } /** - * \ingroup Util * \brief Get the current date of the system in a dicom string */ std::string Util::GetCurrentDate() @@ -258,7 +250,6 @@ std::string Util::GetCurrentDate() } /** - * \ingroup Util * \brief Get the current time of the system in a dicom string */ std::string Util::GetCurrentTime() @@ -286,7 +277,6 @@ std::string Util::DicomString(const char *s, size_t l) } /** - * \ingroup Util * \brief Create a /DICOM/ string: * It should a of even lenght (no odd length ever) * It can contain as many (if you are reading this from your @@ -310,7 +300,6 @@ std::string Util::DicomString(const char *s) } /** - * \ingroup Util * \brief Safely compare two Dicom String: * - Both string should be of even lenght * - We allow padding of even lenght string by either a null @@ -331,7 +320,6 @@ bool Util::DicomStringEqual(const std::string &s1, const char *s2) /** - * \ingroup Util * \brief tells us if the processor we are working with is BigEndian or not */ bool Util::IsCurrentProcessorBigEndian() @@ -639,6 +627,9 @@ int GetMacAddrSys ( unsigned char *addr ) #endif //__sun } +/** + * \brief Gets the M.A.C. adress of the machine writting the DICOM image + */ std::string Util::GetMACAddress() { // This code is the result of a long internet search to find something @@ -668,7 +659,6 @@ std::string Util::GetMACAddress() } /** - * \ingroup Util * \brief Return the IP adress of the machine writting the DICOM image */ std::string Util::GetIPAddress() @@ -730,7 +720,6 @@ std::string Util::GetIPAddress() } /** - * \ingroup Util * \brief Creates a new UID. As stipulate in the DICOM ref * each time a DICOM image is create it should have * a unique identifier (URI) @@ -756,12 +745,22 @@ std::string Util::CreateUniqueUID(const std::string &root) return radical; } +/** + * \brief + * @param os ostream to write to + * @param val val + */ template std::ostream &binary_write(std::ostream &os, const T &val) { return os.write(reinterpret_cast(&val), sizeof val); } +/** + * \brief binary_write binary_write + * @param os ostream to write to + * @param val val + */ std::ostream &binary_write(std::ostream &os, const uint16_t &val) { #ifdef GDCM_WORDS_BIGENDIAN @@ -773,6 +772,11 @@ std::ostream &binary_write(std::ostream &os, const uint16_t &val) #endif //GDCM_WORDS_BIGENDIAN } +/** + * \brief binary_write binary_write + * @param os ostream to write to + * @param val val + */ std::ostream &binary_write(std::ostream &os, const uint32_t &val) { #ifdef GDCM_WORDS_BIGENDIAN @@ -785,11 +789,21 @@ std::ostream &binary_write(std::ostream &os, const uint32_t &val) #endif //GDCM_WORDS_BIGENDIAN } +/** + * \brief binary_write binary_write + * @param os ostream to write to + * @param val val + */ std::ostream &binary_write(std::ostream &os, const char *val) { return os.write(val, strlen(val)); } +/** + * \brief + * @param os ostream to write to + * @param val val + */ std::ostream &binary_write(std::ostream &os, std::string const &val) { return os.write(val.c_str(), val.size()); -- 2.45.2