From ce2ceb5b9c3352c125f5eb8a63fe9ea1778f0099 Mon Sep 17 00:00:00 2001
From: "E. Kozlovskaya" <elenakozlovskaa15@gmail.com>
Date: Tue, 5 Jan 2021 21:51:27 +0700
Subject: [PATCH] Add docs for User's Professions ViewModel

---
 .../viewmodels/userprofessionviewmodel.h      | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/iFacility/viewmodels/userprofessionviewmodel.h b/iFacility/viewmodels/userprofessionviewmodel.h
index 110b2eb..4dc0454 100644
--- a/iFacility/viewmodels/userprofessionviewmodel.h
+++ b/iFacility/viewmodels/userprofessionviewmodel.h
@@ -7,21 +7,71 @@
 #include "../objects/user.h"
 #include "../db/database.h"
 
+/**
+ * @brief ViewModel для таблицы профессий пользователя
+ * 
+ */
 class UserProfessionViewModel : public QAbstractTableModel {
 private:
     Q_OBJECT
 
+    /**
+     * @brief Ссылка на объект пользователя, профессии которые будут отображаться
+     * 
+     * @param user 
+     */
     User *mUser = nullptr;
 
 public:
+    /**
+     * @brief Стандартный конструктор объекта класса
+     * 
+     * @param parent родитель, для определения периодов жизни ViewModel
+     */
     UserProfessionViewModel(QObject *parent);
 
+    /**
+     * @brief Возвращает кол-во строк в таблице
+     * 
+     * @param parent [ignored]
+     * @return int кол-во строк в таблице
+     */
     int rowCount(const QModelIndex &parent = QModelIndex()) const;
+    /**
+     * @brief Возвращает кол-во столбцов в таблице
+     * 
+     * @param parent [ignored]
+     * @return int кол-во столбцов в таблице
+     */
     int columnCount(const QModelIndex &parent = QModelIndex()) const;
+    /**
+     * @brief Возвращает содержимое заголовка таблицы
+     * 
+     * @param section [ignored]
+     * @param orientation положение заголовка таблицы
+     * @param role [ignored]
+     * @return QVariant содержимое заголовка
+     */
     QVariant headerData(int section, Qt::Orientation orientation, int role) const;
+    /**
+     * @brief Возвращает содержимое ячеек таблицы
+     * 
+     * @param index индекс текущей ячейки
+     * @param role какая часть таблицы отрисовывается (данные, стили и т.д.)
+     * @return QVariant содержимое ячейки
+     */
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
 
+    /**
+     * @brief Устанавливает пользователя, профессии которые будут отображаться
+     * 
+     * @param user 
+     */
     void setUser(User *user);
+    /**
+     * @brief Запускает перерисовку таблицы
+     * 
+     */
     void invalidateData();
 };