From 8a359d1fc92d43422710f3694a20f141609b7982 Mon Sep 17 00:00:00 2001 From: jpr Date: Wed, 4 Feb 2004 17:42:24 +0000 Subject: [PATCH] doxygenation --- Doc/README | 5 ++++- src/gdcmDictEntry.cxx | 22 +++++++++++----------- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/Doc/README b/Doc/README index 67d1b05c..50bd05fb 100644 --- a/Doc/README +++ b/Doc/README @@ -1,6 +1,9 @@ -The reference for parsing dicom file is the dicom standard. A locat copy +The reference for parsing dicom file is the dicom standard. A local copy can be found in Dicom2003_Part5.pdf. A nice starting point for browsing the standard can be found at http://www.dclunie.com/dicom-status/status.html. +better you go to : http://medical.nema.org/dicom + PRODUCTS + The Dicom Standard Documentation can be build with doxygen: * For the developpers version: diff --git a/src/gdcmDictEntry.cxx b/src/gdcmDictEntry.cxx index 0bc2afa9..c4b30838 100644 --- a/src/gdcmDictEntry.cxx +++ b/src/gdcmDictEntry.cxx @@ -9,24 +9,24 @@ // Constructor / Destructor /** * \ingroup gdcmDictEntry - * \brief Construtor - * @param InGroup - * @param InElement - * @param InVr + * \brief Constructor + * @param InGroup DICOM-Group Number + * @param InElement DICOM-Element Number + * @param InVr Value Representatiion * @param InFourth // DO NOT use any longer * NOT part of the Dicom Standard - * @param InName + * @param InName description of the element */ gdcmDictEntry::gdcmDictEntry(guint16 InGroup, guint16 InElement, std::string InVr, std::string InFourth, std::string InName) { group = InGroup; - element = InElement; - vr = InVr; + element = InElement; + vr = InVr; fourth = InFourth; - name = InName; - key = TranslateToKey(group, element); + name = InName; + key = TranslateToKey(group, element); } //----------------------------------------------------------------------------- @@ -40,7 +40,7 @@ gdcmDictEntry::gdcmDictEntry(guint16 InGroup, guint16 InElement, * and a Dicom element number) * @param group the Dicom group number used to build the tag * @param element the Dicom element number used to build the tag - * return the built tag + * @return the built tag */ TagKey gdcmDictEntry::TranslateToKey(guint16 group, guint16 element) { @@ -57,7 +57,7 @@ TagKey gdcmDictEntry::TranslateToKey(guint16 group, guint16 element) { /** * \ingroup gdcmDictEntry * \brief If-and only if-the V(alue) R(epresentation) - * is unset then overwrite it. + * \ is unset then overwrite it. * @param NewVr New V(alue) R(epresentation) to be set. */ void gdcmDictEntry::SetVR(std::string NewVr) -- 2.48.1