Merge pull request #4 from QuasarApp/task_3

Documentation correction

notificationdata.h

@@ -5,7 +5,8 @@
 namespace QmlNotificationService {
 
 /**
- * @brief The NotificationData class view data for NotificationServiceView
+ * @brief The NotificationData class view data for NotificationServiceView. This class contains a structure with notification data.
+
  */
 class NOTIFYSERVICESHARED_EXPORT NotificationData
 {

notificationservice.h

@@ -8,7 +8,7 @@
 namespace QmlNotificationService {
 
 /**
- * @brief The NotificationService class
+ * @brief The NotificationService class. This class used for working with notify.
  */
 class NOTIFYSERVICESHARED_EXPORT NotificationService: public QObject
 {
@@ -21,15 +21,15 @@ class NOTIFYSERVICESHARED_EXPORT NotificationService: public QObject
 
 public:
     /**
-     * @brief notify
+     * @brief Notify.
-     * @return notyfyData for qml
+     * @return notyfyData for qml.
      */
     NotificationData notify() const;
     NotificationData question() const;
 
     /**
-     * @brief setNotify - add new message for application
+     * @brief setNotify - Add new message for application.
-     * @param notify - message data
+     * @param notify - Message data.
      */
     void setNotify(const NotificationData &notify);
 
@@ -48,14 +48,14 @@ public:
 
 
     /**
-     * @brief getService
+     * @brief getService - This method return instance to notify service. 
-     * @return pointer t oservice
+     * @return pointer to service.
      */
     static NotificationService* getService();
 
     /**
-     * @brief history
+     * @brief history - This method used for return notify list.
-     * @return list of all notify
+     * @return list of all notify.
      */
     const QList<NotificationData> & history() const;