Clean and order documentation in source files. Source ready to beta 2 release

[mdictionary] / src / plugins / xdxf / DictsModel.h

diff --git a/src/plugins/xdxf/DictsModel.h b/src/plugins/xdxf/DictsModel.h
index ad83848..241b042 100644 (file)
--- a/src/plugins/xdxf/DictsModel.h
+++ b/src/plugins/xdxf/DictsModel.h
@@ -18,10 +18,11 @@
     Copyright 2010 Comarch S.A.
 
 *******************************************************************************/
-
 /*!
- \file DictsModel.h
- \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+   \file DictsModel.h
+   \brief Item model for informations about xdxf dictionaries.
+
+   \author Mateusz Półrola <mateusz.polrola@comarch.pl>
 */
 
 #ifndef DICTSMODEL_H
@@ -43,19 +44,31 @@ class DictsModel : public QAbstractItemModel
     Q_OBJECT
 public:
     /*!
-      Constructor
-      \param dicts list of DownloadDict objects, each such object describes
+        Constructor
+        \param dicts list of DownloadDict objects, each such object describes
         one dictionary
-      */
+    */
     DictsModel(QList<DownloadDict> dicts, QObject *parent);
 
+    //! \return return numner of rows
     int rowCount(const QModelIndex &parent = QModelIndex()) const;
+
+    //! \return return numner of columns
     int columnCount(const QModelIndex &parent = QModelIndex()) const;
 
+    //!  create Index,  createIndex(row,column,row)
     QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
+
+    //! return new QModelIndex;
     QModelIndex parent(const QModelIndex &child) const;
 
+    /*!
+        \return return empty QVariant when role is't DisplayRole,
+        else return QVariant (QString with _from,_to,_title)
+    */
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
+
+    //! \return return a QVariant with header QString.
     QVariant headerData(int section, Qt::Orientation orientation, int role) const;
 
 private: