More doxygen style fixes in Libs/DICOM

Libs/DICOM/Core/ctkDICOMAbstractThumbnailGenerator.h

@@ -30,15 +30,15 @@
 class ctkDICOMAbstractThumbnailGeneratorPrivate;
 class DicomImage;
 
-/**
-  \brief Abstract thumbnail generator class
-*/
+///
+/// \brief Abstract thumbnail generator class
+///
 class CTK_DICOM_CORE_EXPORT ctkDICOMAbstractThumbnailGenerator : public QObject
 {
   Q_OBJECT
 public:
-  /** \brief Construct a ctkDICOMAbstractThumbnailGenerator object
-  */
+  ///  \brief Construct a ctkDICOMAbstractThumbnailGenerator object
+  ///
   explicit ctkDICOMAbstractThumbnailGenerator(QObject* parent = 0);
   virtual ~ctkDICOMAbstractThumbnailGenerator();
 

Libs/DICOM/Core/ctkDICOMDatabase.h

@@ -121,25 +121,25 @@ public:
   Q_INVOKABLE QStringList headerKeys ();
   Q_INVOKABLE QString headerValue (QString key);
 
-  /** Insert into the database if not already exsting.
-    *  @param dataset The dataset to store into the database. Usually, this is
-    *                 is a complete DICOM object, like a complete image. However
-    *                 the database also inserts partial objects, like studyl
-    *                 information to the database, even if no image data is
-    *                 contained. This can be helpful to store results from
-    *                 querying the PACS for patient/study/series or image
-    *                 information, where a full hierarchy is only constructed
-    *                 after some queries.
-    *  @param storeFile If store file is set (default), then the dataset will
-    *                   be stored to disk. Note that in case of a memory-only
-    *                   database, this flag is ignored. Usually, this flag
-    *                   does only make sense if a full object is received.
-    *  @param @generateThumbnail If true, a thumbnail is generated.
-    */
+  /// Insert into the database if not already exsting.
+  /// @param dataset The dataset to store into the database. Usually, this is
+  ///                is a complete DICOM object, like a complete image. However
+  ///                the database also inserts partial objects, like studyl
+  ///                information to the database, even if no image data is
+  ///                contained. This can be helpful to store results from
+  ///                querying the PACS for patient/study/series or image
+  ///                information, where a full hierarchy is only constructed
+  ///                after some queries.
+  /// @param storeFile If store file is set (default), then the dataset will
+  ///                  be stored to disk. Note that in case of a memory-only
+  ///                  database, this flag is ignored. Usually, this flag
+  ///                  does only make sense if a full object is received.
+  /// @param @generateThumbnail If true, a thumbnail is generated.
+  ///
   void insert ( DcmDataset *dataset, bool storeFile = true, bool generateThumbnail = true);
-  /***
-    * Helper method: get the path that should be used to store this image.
-    */
+  ///
+  /// Helper method: get the path that should be used to store this image.
+  ///
   QString pathForDataset( DcmDataset *dataset);
 
 signals:

Libs/DICOM/Core/ctkDICOMIndexer.h

@@ -21,7 +21,7 @@
 #ifndef __ctkDICOMIndexer_h
 #define __ctkDICOMIndexer_h
 
-// Qt includes 
+// Qt includes
 #include <QObject>
 #include <QSqlDatabase>
 
@@ -31,44 +31,44 @@
 class ctkDICOMIndexerPrivate;
 class ctkDICOMAbstractThumbnailGenerator;
 
-/**
-    \brief Indexes DICOM images located in local directory into an Sql database
-*/
+///
+/// \brief Indexes DICOM images located in local directory into an Sql database
+///
 class CTK_DICOM_CORE_EXPORT ctkDICOMIndexer : public QObject
 {
   Q_OBJECT
 public:
   explicit ctkDICOMIndexer(QObject *parent = 0);
   virtual ~ctkDICOMIndexer();
-  
-  /**
-      \brief Adds directory to database and optionally copies files to
-      destinationDirectory.
-      
-      Scan the directory using Dcmtk and populate the database with all the
-      DICOM images accordingly.
-  */
+
+  ///
+  /// \brief Adds directory to database and optionally copies files to
+  /// destinationDirectory.
+  ///
+  /// Scan the directory using Dcmtk and populate the database with all the
+  /// DICOM images accordingly.
+  ///
   Q_INVOKABLE void addDirectory(ctkDICOMDatabase& database, const QString& directoryName,
                     const QString& destinationDirectoryName = "",
                     bool createHierarchy = true, bool createThumbnails = true);
 
-  /**
-      \brief Adds a file to database and optionally copies the file to
-      destinationDirectory.
- 
-      Scan the file using Dcmtk and populate the database with all the
-      DICOM fields accordingly.
-  */
+  ///
+  /// \brief Adds a file to database and optionally copies the file to
+  /// destinationDirectory.
+  ///
+  /// Scan the file using Dcmtk and populate the database with all the
+  /// DICOM fields accordingly.
+  ///
   Q_INVOKABLE void addFile(ctkDICOMDatabase& database, const QString& filePath,
                     const QString& destinationDirectoryName = "",
                     bool createHierarchy = true, bool createThumbnails = true);
 
   Q_INVOKABLE void refreshDatabase(ctkDICOMDatabase& database, const QString& directoryName);
 
-  /**
-      \brief runs a query and prints debug output of status
- 
-  */
+  ///
+  /// \brief runs a query and prints debug output of status
+  ///
+  ///
   bool loggedExec(QSqlQuery& query);
   bool loggedExec(QSqlQuery& query, const QString& queryString);
 
@@ -87,7 +87,7 @@ signals:
 
 protected:
   QScopedPointer<ctkDICOMIndexerPrivate> d_ptr;
-  
+
 private:
   Q_DECLARE_PRIVATE(ctkDICOMIndexer);
   Q_DISABLE_COPY(ctkDICOMIndexer);

Libs/DICOM/Core/ctkDICOMPersonName.h

@@ -31,9 +31,9 @@
 #include <string>
 
 class ctkDICOMPersonNameData;
-/**
-  \brief A person's name as modelled in DICOM.
-*/
+///
+/// \brief A person's name as modelled in DICOM.
+///
 class CTK_DICOM_CORE_EXPORT ctkDICOMPersonName
 {
 public:
@@ -48,9 +48,9 @@ public:
   ctkDICOMPersonName& operator=(const ctkDICOMPersonName& other);
 
   virtual ~ctkDICOMPersonName();
-  /**
-    \brief "Lastname, FirstName MiddleName, Suffix" (useful for alphabetical sorting)
-  */
+  ///
+  /// \brief "Lastname, FirstName MiddleName, Suffix" (useful for alphabetical sorting)
+  ///
   QString formattedName() const;
 
   QString lastName() const;

Libs/DICOM/Core/ctkDICOMTester.h

@@ -21,7 +21,7 @@
 #ifndef __ctkDICOMTester_h
 #define __ctkDICOMTester_h
 
-// Qt includes 
+// Qt includes
 #include <QObject>
 class QProcess;
 
@@ -29,11 +29,11 @@ class QProcess;
 #include "ctkDICOMCoreExport.h"
 class ctkDICOMTesterPrivate;
 
-/** \brief Utility class to test DICOM network applications
-    A simple DICOM archive server can be run (startDCMQRSCP()), and images
-    can be stored into the server using storeData(). It internally uses
-    storeSCU.
- */
+/// \brief Utility class to test DICOM network applications
+/// A simple DICOM archive server can be run (startDCMQRSCP()), and images
+/// can be stored into the server using storeData(). It internally uses
+/// storeSCU.
+///
 class CTK_DICOM_CORE_EXPORT ctkDICOMTester : public QObject
 {
   Q_OBJECT
@@ -55,32 +55,32 @@ public:
   void setStoreSCUExecutable(const QString& storescu);
   QString storeSCUExecutable()const;
 
-  /** Port number [0,65365] where the dcmqrscp and storescu communicate.
-      Changing the port won't change the port of any running process.
-      You must stop and restart any process you want to have its port changed
-  */
+  ///  Port number [0,65365] where the dcmqrscp and storescu communicate.
+  /// Changing the port won't change the port of any running process.
+  /// You must stop and restart any process you want to have its port changed
+  ///
   void setDCMQRSCPPort(int port);
   int dcmqrscpPort()const;
 
-  /** Starts a new DCMQRSCP as a separate process. The process is running until
-      stopDCMQRSCP is called or ctkDICOMTester is destroyed.
-      Only one process of DCMQRSCP can be running at a time.
-      Calling startDCMQRSCP() while a DCMQRSCP process is already running
-      results into a no-op. The return value is 0.
-      \sa QProcess::start(),
-   */
+  ///  Starts a new DCMQRSCP as a separate process. The process is running until
+  /// stopDCMQRSCP is called or ctkDICOMTester is destroyed.
+  /// Only one process of DCMQRSCP can be running at a time.
+  /// Calling startDCMQRSCP() while a DCMQRSCP process is already running
+  /// results into a no-op. The return value is 0.
+  /// \sa QProcess::start(),
+  ///
   Q_INVOKABLE QProcess* startDCMQRSCP();
 
-  /** Stop the running DCMQRSCP process. Returns it's exit status or false if
-      there is no running process.
-  */
+  ///  Stop the running DCMQRSCP process. Returns it's exit status or false if
+  /// there is no running process.
+  ///
   Q_INVOKABLE bool stopDCMQRSCP();
 
-  /** Pushes data (DCM images referred to by file name in data list) using DCMTK 
-      storeSCU app. It creates a separate process and waits for its termination.
-      To be working, dcmqrscp must be running
-      \sa startDCMQRSCP()
-   */
+  ///  Pushes data (DCM images referred to by file name in data list) using DCMTK
+  /// storeSCU app. It creates a separate process and waits for its termination.
+  /// To be working, dcmqrscp must be running
+  /// \sa startDCMQRSCP()
+  ///
   Q_INVOKABLE bool storeData(const QStringList& data);
 
 protected:

Libs/DICOM/Widgets/ctkDICOMImage.h

@@ -22,7 +22,7 @@
 #ifndef __ctkDICOMImage_h
 #define __ctkDICOMImage_h
 
-// Qt includes 
+// Qt includes
 #include <QObject>
 #include <QImage>
 
@@ -31,45 +31,45 @@
 class ctkDICOMImagePrivate;
 class DicomImage;
 
-/**
-  \brief Wrapper around a DCMTK DicomImage.
-
-  This class wraps a DicomImage object and exposes it as a Qt class.
-*/
+///
+/// \brief Wrapper around a DCMTK DicomImage.
+///
+/// This class wraps a DicomImage object and exposes it as a Qt class.
+///
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMImage : public QObject
 {
   Q_OBJECT
   Q_PROPERTY(unsigned long frameCount READ frameCount);
 public:
-  /** \brief Construct a ctkDICOMImage
-      The dicomImage pointer must remain valid during all the life of
-      the constructed ctkDICOMImage.
-  */
+  ///  \brief Construct a ctkDICOMImage
+  /// The dicomImage pointer must remain valid during all the life of
+  /// the constructed ctkDICOMImage.
+  ///
   explicit ctkDICOMImage(DicomImage* dicomImage, QObject* parent = 0);
   virtual ~ctkDICOMImage();
 
-  /**
-      \brief Returns the pointer on the dicom image given in the constructor.
-      
-      This is provided as a utility function. Do not delete the returned
-      pointer.
-      TBD: Return a "const DicomImage*" instead?
-  */
+  ///
+  /// \brief Returns the pointer on the dicom image given in the constructor.
+  ///
+  /// This is provided as a utility function. Do not delete the returned
+  /// pointer.
+  /// TBD: Return a "const DicomImage*" instead?
+  ///
   DicomImage* dicomImage() const;
 
-  /**
-      \brief Returns a specific frame of the dicom image
-  */
+  ///
+  /// \brief Returns a specific frame of the dicom image
+  ///
   QImage frame(int frame = 0) const;
 
-  /**
-      \brief Returns the number of frames contained in the dicom image.
-      \sa DicomImage::getFrameCount()
-
-      Please note that this function does not return the number of frames
-      stored in the DICOM file/dataset. It rather refers to the number of
-      frames processed by this class.
-  */
+  ///
+  /// \brief Returns the number of frames contained in the dicom image.
+  /// \sa DicomImage::getFrameCount()
+  ///
+  /// Please note that this function does not return the number of frames
+  /// stored in the DICOM file/dataset. It rather refers to the number of
+  /// frames processed by this class.
+  ///
   unsigned long frameCount() const;
 
 protected:

Libs/DICOM/Widgets/ctkDICOMThumbnailGenerator.h

@@ -29,15 +29,15 @@
 class ctkDICOMThumbnailGeneratorPrivate;
 class DicomImage;
 
-/**
-  \brief  thumbnail generator class
-*/
+///
+/// \brief  thumbnail generator class
+///
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMThumbnailGenerator : public ctkDICOMAbstractThumbnailGenerator
 {
   Q_OBJECT
 public:
-  /** \brief Construct a ctkDICOMThumbnailGenerator object
-  */
+  ///  \brief Construct a ctkDICOMThumbnailGenerator object
+  ///
   explicit ctkDICOMThumbnailGenerator(QObject* parent = 0);
   virtual ~ctkDICOMThumbnailGenerator();