diff src/metadataview.h @ 66:098a10fc2e83 0.9.2

Add doxygen files and improve doxygen comments
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 21 May 2015 15:21:47 +0200
parents 28d5a77db9fb
children 5923d569167b
line wrap: on
line diff
--- a/src/metadataview.h	Thu May 21 14:30:56 2015 +0200
+++ b/src/metadataview.h	Thu May 21 15:21:47 2015 +0200
@@ -7,6 +7,12 @@
  * and comes with ABSOLUTELY NO WARRANTY!
  * See LICENSE.txt for details.
  */
+
+/**
+ * @file  metadataview.h
+ * @brief Table view of the meta data information
+ */
+
 #include <QWidget>
 #include <QItemSelection>
 #include <QDateTime>
@@ -14,6 +20,11 @@
 class QTableView;
 class QSortFilterProxyModel;
 class QxtCsvModel;
+
+/**
+ * @class MetaDataView
+ * @brief Table view of the meta data data information.
+ */
 class MetaDataView: public QWidget
 {
     Q_OBJECT
@@ -25,14 +36,15 @@
     void setupGUI();
 
 public:
-    /**@brief parse a metadata file and set up the model accordingly.
+    /**
+     * @brief parse a metadata file and set up the model accordingly.
      *
      * @returns a localized error message in case of parsing errors. Or
      * an empty string on success. */
     QString parseMetaData(const QString& fileName);
 
 Q_SIGNALS:
-    /**@brief emited when the selection changed. */
+    /** @brief emited when the selection changed. */
     void selectionChanged(const QString& pictureFile, int current, int max,
         const QString& timestamp, int number);
 
@@ -44,22 +56,22 @@
     void dataChanged();
 
 public slots:
-    /**@brief selects the next row and emits a selection changed signal */
+    /** @brief selects the next row and emits a selection changed signal */
     void selectNextRow();
 
-    /**@brief selects the previous row and emits a selection changed signal */
+    /** @brief selects the previous row and emits a selection changed signal */
     void selectPrevRow();
 
-    /**@brief select a specific row. */
+    /** @brief select a specific row. */
     void selectRow(int row);
 
-    /**@brief select the first row. */
+    /** @brief select the first row. */
     void selectFirstRow();
 
-    /**@brief applies the default sort order from configuration */
+    /** @brief applies the default sort order from configuration */
     void applyDefaultSort();
 
-    /**@brief resizes the columns to headers content */
+    /** @brief resizes the columns to headers content */
     void resizeColsToHeaders();
 
 protected:
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)