From: jpr Date: Thu, 6 Jan 2005 16:05:06 +0000 (+0000) Subject: Doxygenation X-Git-Tag: Version1.0.bp~469 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=74e3bc05fade5a18f193e7d1122c74756c0e689e;p=gdcm.git Doxygenation --- diff --git a/src/gdcmDicomDirObject.cxx b/src/gdcmDicomDirObject.cxx index 1d3d8ce2..d4d62160 100644 --- a/src/gdcmDicomDirObject.cxx +++ b/src/gdcmDicomDirObject.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDicomDirObject.cxx,v $ Language: C++ - Date: $Date: 2004/12/07 13:39:33 $ - Version: $Revision: 1.12 $ + Date: $Date: 2005/01/06 16:05:06 $ + Version: $Revision: 1.13 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -27,11 +27,8 @@ namespace gdcm //----------------------------------------------------------------------------- /** - * \ingroup DicomDirObject * \brief Constructor * - * @param ptagHT pointer to the HTable (DicomDirObject needs it - * to build the DocEntries) * @param depth Sequence depth level */ @@ -42,7 +39,6 @@ DicomDirObject::DicomDirObject(int depth) /** - * \ingroup DicomDirObject * \brief Canonical destructor. */ DicomDirObject::~DicomDirObject() @@ -50,13 +46,11 @@ DicomDirObject::~DicomDirObject() } - //----------------------------------------------------------------------------- // Public /** - * \ingroup DicomDirObject * \brief Builds a hash table (multimap) containing * pointers to all Header Entries (i.e Dicom Element) * related to this 'object' @@ -79,6 +73,7 @@ TagDocEntryHT DicomDirObject::GetEntry() /** * \brief add the 'Object' related Dicom Elements to the listEntries * of a partially created DICOMDIR + * @param elemList Element List to add at the right place */ void DicomDirObject::FillObject(ListDicomDirMetaElem const & elemList) { diff --git a/src/gdcmDicomDirPatient.cxx b/src/gdcmDicomDirPatient.cxx index fb5fa9ac..f01d3984 100644 --- a/src/gdcmDicomDirPatient.cxx +++ b/src/gdcmDicomDirPatient.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDicomDirPatient.cxx,v $ Language: C++ - Date: $Date: 2004/12/03 20:16:57 $ - Version: $Revision: 1.21 $ + Date: $Date: 2005/01/06 16:05:06 $ + Version: $Revision: 1.22 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -29,8 +29,6 @@ namespace gdcm // Constructor / Destructor /** * \brief Constructor - * @param ptagHT pointer to the HTable (DicomDirObject needs it - * to build the HeaderEntries) */ DicomDirPatient::DicomDirPatient(): DicomDirObject() @@ -53,7 +51,7 @@ DicomDirPatient::~DicomDirPatient() // Print /** * \brief Prints the Object - * @return + * @param os ostream to write to */ void DicomDirPatient::Print(std::ostream& os) { @@ -71,7 +69,8 @@ void DicomDirPatient::Print(std::ostream& os) /** * \brief Writes the Object - * @return + * @param fp ofstream to write to + * @param t Type of the File (explicit VR, implicitVR, ...) */ void DicomDirPatient::WriteContent(std::ofstream* fp, FileType t) { diff --git a/src/gdcmDicomDirSerie.cxx b/src/gdcmDicomDirSerie.cxx index 541cee2f..5055d4b6 100644 --- a/src/gdcmDicomDirSerie.cxx +++ b/src/gdcmDicomDirSerie.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDicomDirSerie.cxx,v $ Language: C++ - Date: $Date: 2004/12/03 20:16:57 $ - Version: $Revision: 1.23 $ + Date: $Date: 2005/01/06 16:05:06 $ + 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 @@ -28,8 +28,6 @@ namespace gdcm // Constructor / Destructor /** * \brief Constructor - * @param ptagHT pointer to the HTable (DicomDirObject needs it - * to build the DocEntries) */ DicomDirSerie::DicomDirSerie(): DicomDirObject() @@ -52,7 +50,7 @@ DicomDirSerie::~DicomDirSerie() // Print /** * \brief Prints the Object - * @return + * @param os ostream to write to */ void DicomDirSerie::Print(std::ostream& os) { @@ -73,7 +71,8 @@ void DicomDirSerie::Print(std::ostream& os) /** * \brief Writes the Object - * @return + * @param fp ofstream to write to + * @param t Type of the File (explicit VR, implicitVR, ...) */ void DicomDirSerie::WriteContent(std::ofstream* fp, FileType t) { diff --git a/src/gdcmDicomDirStudy.cxx b/src/gdcmDicomDirStudy.cxx index c4678132..1c940c7e 100644 --- a/src/gdcmDicomDirStudy.cxx +++ b/src/gdcmDicomDirStudy.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDicomDirStudy.cxx,v $ Language: C++ - Date: $Date: 2004/12/03 20:16:57 $ - Version: $Revision: 1.20 $ + Date: $Date: 2005/01/06 16:05:06 $ + 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 @@ -26,10 +26,7 @@ namespace gdcm //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup DicomDirStudy - * \brief constructor - * @param ptagHT pointer to the HTable (DicomDirObject needs it - * to build the HeaderEntries) + * \brief Constructor */ DicomDirStudy::DicomDirStudy(): DicomDirObject() @@ -52,8 +49,8 @@ DicomDirStudy::~DicomDirStudy() //----------------------------------------------------------------------------- // Print /** - * \ingroup DicomDirStudy * \brief Prints the Object + * @param os ostream to write to * @return */ void DicomDirStudy::Print(std::ostream& os) @@ -75,6 +72,8 @@ void DicomDirStudy::Print(std::ostream& os) /** * \brief Writes the Object + * @param fp ofstream to write to + * @param t Type of the File (explicit VR, implicitVR, ...) * @return */ void DicomDirStudy::WriteContent(std::ofstream* fp, FileType t) @@ -90,7 +89,6 @@ void DicomDirStudy::WriteContent(std::ofstream* fp, FileType t) } /** - * \ingroup DicomDirStudy * \brief adds a new Serie at the begining of the SerieList * of a partially created DICOMDIR */ diff --git a/src/gdcmDocEntryArchive.cxx b/src/gdcmDocEntryArchive.cxx index fae78fcd..38ba52d7 100644 --- a/src/gdcmDocEntryArchive.cxx +++ b/src/gdcmDocEntryArchive.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocEntryArchive.cxx,v $ Language: C++ - Date: $Date: 2004/12/03 20:16:58 $ - Version: $Revision: 1.4 $ + Date: $Date: 2005/01/06 16:05:06 $ + Version: $Revision: 1.5 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -102,7 +102,8 @@ bool DocEntryArchive::Push(DocEntry *newEntry) /** * \brief Replace in the Header a DocEntry by the new DocEntry. The last * DocEntry is kept in archieve - * @param newEntry New entry to substitute to an other entry of the Header + * @param group Group number of the Entry + * @param element Element number of the Entry * @return FALSE when an other DocEntry is already archieved with the same * generalized key, TRUE otherwise */ @@ -128,7 +129,8 @@ bool DocEntryArchive::Push(uint16_t group,uint16_t element) /** * \brief Restore in the Header the DocEntry that have the generalized key. * The old entry is destroyed. - * @param key Key of the DocEntry to restore + * @param group Group number of the Entry + * @param element Element number of the Entry * @return FALSE when the generalized key isn't in the archieve, * TRUE otherwise */ diff --git a/src/gdcmDocument.cxx b/src/gdcmDocument.cxx index 0d865c24..2a2c88e1 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 15:36:48 $ - Version: $Revision: 1.157 $ + Date: $Date: 2005/01/06 16:05:06 $ + Version: $Revision: 1.158 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -47,7 +47,7 @@ namespace gdcm static const char *TransferSyntaxStrings[] = { // Implicit VR Little Endian "1.2.840.10008.1.2", - // Implicit VR Little Endian DLX G.E? + // Implicit VR Big Endian DLX G.E? "1.2.840.113619.5.2", // Explicit VR Little Endian "1.2.840.10008.1.2.1", @@ -1801,7 +1801,7 @@ void Document::FindDocEntryLength( DocEntry *entry ) /** * \brief Find the Value Representation of the current Dicom Element. - * @param entry + * @return Value Representation of the current Entry */ std::string Document::FindDocEntryVR() { @@ -1833,7 +1833,6 @@ std::string Document::FindDocEntryVR() * \brief Check the correspondance between the VR of the header entry * and the taken VR. If they are different, the header entry is * updated with the new VR. - * @param entry Header Entry to check * @param vr Dicom Value Representation * @return false if the VR is incorrect of if the VR isn't referenced * otherwise, it returns true diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index 395f8bd2..70da398e 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 14:49:16 $ - Version: $Revision: 1.181 $ + Date: $Date: 2005/01/06 16:05:06 $ + Version: $Revision: 1.182 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -544,9 +544,9 @@ bool File::SetEntryByNumber(uint8_t* content, int lgth, /** * \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 content (string) Value to be set * @param group Group number of the Entry - * @param elem Element number of the Entry + * @param element Element number of the Entry * \return pointer to the modified/created Header Entry (NULL when creation * failed). */ @@ -561,8 +561,8 @@ bool File::ReplaceOrCreateByNumber(std::string const& content, * 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 + * @param group Group number of the Entry + * @param element Element number of the Entry * \return pointer to the modified/created Header Entry (NULL when creation * failed). */ diff --git a/src/gdcmHeader.cxx b/src/gdcmHeader.cxx index bc28cd19..2c356edd 100644 --- a/src/gdcmHeader.cxx +++ b/src/gdcmHeader.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmHeader.cxx,v $ Language: C++ - Date: $Date: 2005/01/06 15:36:48 $ - Version: $Revision: 1.220 $ + Date: $Date: 2005/01/06 16:05:06 $ + Version: $Revision: 1.221 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -121,7 +121,7 @@ Header::~Header () * \brief Performs some consistency checking on various 'File related' * (as opposed to 'DicomDir related') entries * then writes in a file all the (Dicom Elements) included the Pixels - * @param fp file pointer on an already open file + * @param fileName file name to write to * @param filetype Type of the File to be written * (ACR-NEMA, ExplicitVR, ImplicitVR) */ diff --git a/src/gdcmPixelReadConvert.h b/src/gdcmPixelReadConvert.h index 140a2857..79d882a6 100644 --- a/src/gdcmPixelReadConvert.h +++ b/src/gdcmPixelReadConvert.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmPixelReadConvert.h,v $ Language: C++ - Date: $Date: 2004/12/16 13:46:37 $ - Version: $Revision: 1.7 $ + Date: $Date: 2005/01/06 16:07:34 $ + Version: $Revision: 1.8 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -93,11 +93,11 @@ private: // Variables /// Pixel data represented as RGB after LUT color interpretation. uint8_t* RGB; - /// Size of \ref RGB image. + /// Size of RGB image. size_t RGBSize; /// Pixel data after decompression and bit/byte rearrangement. uint8_t* Raw; - /// Size of \ref Decompressed image. + /// Size of Decompressed image. size_t RawSize; /// \brief Red/Green/Blue/Alpha LookUpTable build out of the /// Red/Green/Blue LUT descriptors (see \ref BuildLUTRGBA ). diff --git a/src/gdcmPixelWriteConvert.h b/src/gdcmPixelWriteConvert.h index c82cfd5b..597966f1 100644 --- a/src/gdcmPixelWriteConvert.h +++ b/src/gdcmPixelWriteConvert.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmPixelWriteConvert.h,v $ Language: C++ - Date: $Date: 2004/12/16 13:46:37 $ - Version: $Revision: 1.3 $ + Date: $Date: 2005/01/06 16:07:34 $ + Version: $Revision: 1.4 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -52,12 +52,12 @@ private: // Variables /// Pixel data represented as RGB after LUT color interpretation. uint8_t* ReadData; - /// Size of \ref RGB image. + /// Size of RGB image. size_t ReadDataSize; /// User pixel data uint8_t* UserData; - /// Size of \ref User image. + /// Size of User image. size_t UserDataSize; }; } // end namespace gdcm