From 896698b2982e97cce7a3b432a09c03641906a960 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Tue, 24 Feb 2015 14:59:35 +0100
Subject: Doc: add docs for TaskRole, FileTaskItem and FileTaskResult

To suppress QDoc errors.

Change-Id: If439fcaff9ca8ac2af1545ebef8d14790b3e3853
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
---
 src/libs/installer/abstractfiletask.cpp | 80 +++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

(limited to 'src/libs')

diff --git a/src/libs/installer/abstractfiletask.cpp b/src/libs/installer/abstractfiletask.cpp
index 05445076f..e4b268850 100644
--- a/src/libs/installer/abstractfiletask.cpp
+++ b/src/libs/installer/abstractfiletask.cpp
@@ -43,6 +43,12 @@ namespace QInstaller {
     The class is not usable as a standalone class but provides common functionality when subclassed.
 */
 
+/*!
+    \inmodule QtInstallerFramework
+    \namespace TaskRole
+    \brief Contains identifiers for tasks.
+*/
+
 /*!
     \enum TaskRole::TaskRole
 
@@ -53,6 +59,80 @@ namespace QInstaller {
     \value UserRole     The first role that can be used for user-specific purposes.
 */
 
+/*!
+    \inmodule QtInstallerFramework
+    \class QInstaller::FileTaskItem
+    \brief The FileTaskItem class represents an item in a file task object.
+*/
+
+/*!
+    \fn FileTaskItem::FileTaskItem()
+
+    Creates a file task item.
+*/
+
+/*!
+    \fn FileTaskItem::FileTaskItem(const QString &s)
+
+    Creates a file task item using the source specified by \a s.
+*/
+
+/*!
+    \fn FileTaskItem::FileTaskItem(const QString &s, const QString &t)
+
+    Creates a file task item using the source specified by \a s and target
+    specified by \a t.
+*/
+
+/*!
+    \fn FileTaskItem::source() const
+
+    Returns the source file of the file task item.
+*/
+
+/*!
+    \fn FileTaskItem::target() const
+
+    Returns the target file of the file task item.
+*/
+
+/*!
+    \inmodule QtInstallerFramework
+    \class QInstaller::FileTaskResult
+    \brief The FileTaskResult class represents the results of a file task.
+*/
+
+/*!
+    \fn FileTaskResult::FileTaskResult()
+
+    Creates file task results.
+*/
+
+/*!
+    \fn FileTaskResult::FileTaskResult(const QString &t, const QByteArray &c, const FileTaskItem &i)
+
+    Creates file task results using the target file specified by \a t, checksum
+    specified by \a c, and file task item specified by \a i.
+*/
+
+/*!
+    \fn FileTaskResult::target() const
+
+    Returns the target file of the task result.
+*/
+
+/*!
+    \fn FileTaskResult::checkSum() const
+
+    Returns the checksum of the task result.
+*/
+
+/*!
+    \fn FileTaskResult::taskItem() const
+
+    Returns file task items.
+*/
+
 /*!
     Constructs an empty abstract file task object.
 */
-- 
cgit v1.2.3