diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-30 13:50:47 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-01-30 14:47:33 +0000 |
| commit | d7bdbb1b3a49873ab8feae16d4e1a9ae09bf17b5 (patch) | |
| tree | 7e8f1fd9ee084f98d5df744cd115032f223338e7 /src/libs/installer/packagemanagercore.cpp | |
| parent | 93a10096f82b9a187fc5bf31a65394033696fb72 (diff) | |
Doc: add docs for arguments and return values
To get rid of QDoc errors.
Change-Id: I4932f1f3ff5fab87eebf24536d63be550582b195
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'src/libs/installer/packagemanagercore.cpp')
| -rw-r--r-- | src/libs/installer/packagemanagercore.cpp | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp index 8600dc114..1b59b1dcd 100644 --- a/src/libs/installer/packagemanagercore.cpp +++ b/src/libs/installer/packagemanagercore.cpp @@ -1137,7 +1137,8 @@ bool PackageManagerCore::testChecksum() const } /*! - Defines if the downloader should try to download sha1 checksums for archives. + The \a test argument determines whether the downloader should try to + download SHA-1 checksums for archives. */ void PackageManagerCore::setTestChecksum(bool test) { @@ -1155,8 +1156,9 @@ ScriptEngine *PackageManagerCore::controlScriptEngine() const } /*! - Appends a component as root component to the internal storage for installer or package manager components. - To append a component as a child to an already existing component, use Component::appendComponent(). Emits + Appends \a component as the root component to the internal storage for + installer or package manager components. To append a component as a child to + an already existing component, use Component::appendComponent(). Emits the componentAdded() signal. */ void PackageManagerCore::appendRootComponent(Component *component) @@ -1222,7 +1224,8 @@ QList<Component *> PackageManagerCore::components(ComponentTypes mask) const } /*! - Appends a component to the internal storage for updater components. Emits the componentAdded() signal. + Appends \a component to the internal storage for updater components. Emits + the componentAdded() signal. */ void PackageManagerCore::appendUpdaterComponent(Component *component) { @@ -1363,9 +1366,13 @@ QString PackageManagerCore::componentsToInstallError() const } /*! - Returns the reason why the component needs to be installed. Reasons can be: The component was scheduled - for installation, the component was added as a dependency for an other component or added as an automatic - dependency. + Returns the reason why \a component needs to be installed: + + \list + \li The component was scheduled for installation. + \li The component was added as a dependency for another component. + \li The component was added as an automatic dependency. + \endlist */ QString PackageManagerCore::installReason(Component *component) const { @@ -1373,8 +1380,10 @@ QString PackageManagerCore::installReason(Component *component) const } /*! - Returns a list of components that depend on \a component. The list can be empty. Note: Auto - installed dependencies are not resolved. + Returns a list of components that depend on \a _component. The list can be + empty. + + \note Automatic dependencies are not resolved. */ QList<Component*> PackageManagerCore::dependees(const Component *_component) const { |