diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-02-24 14:59:35 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-02-25 12:14:57 +0000 |
| commit | 896698b2982e97cce7a3b432a09c03641906a960 (patch) | |
| tree | 7172fac52111322c013ed417d22a8b8e3082d55c /src/libs | |
| parent | d71fe88a0117fa4be377c053fb92cc3d6b0d5f7d (diff) | |
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>
Diffstat (limited to 'src/libs')
| -rw-r--r-- | src/libs/installer/abstractfiletask.cpp | 80 |
1 files changed, 80 insertions, 0 deletions
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 @@ -44,6 +44,12 @@ namespace QInstaller { */ /*! + \inmodule QtInstallerFramework + \namespace TaskRole + \brief Contains identifiers for tasks. +*/ + +/*! \enum TaskRole::TaskRole \value Checksum @@ -54,6 +60,80 @@ namespace QInstaller { */ /*! + \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. */ AbstractFileTask::AbstractFileTask() |