summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorKatja Marttila <katja.marttila@qt.io>2021-02-18 12:24:36 +0200
committerKatja Marttila <katja.marttila@qt.io>2021-02-19 07:51:42 +0200
commitf0d6a98e4f2f19c4a9607722893b25d9260fd006 (patch)
tree56047e80919f77ca212db7947f5b077497f676af /src
parent8997ec51b7603fafe5cd34dcff21ba1151c76f32 (diff)
Documentation fixes
Change-Id: Ibb8da857319eff6119b0296375b6c38578729559 Reviewed-by: Iikka Eklund <iikka.eklund@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/libs/installer/component.cpp10
-rw-r--r--src/libs/kdtools/localpackagehub.cpp1
-rw-r--r--src/libs/kdtools/updateoperation.cpp12
3 files changed, 23 insertions, 0 deletions
diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index ff01e4251..66f333377 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -212,6 +212,16 @@ static const QLatin1String scUnstable("Unstable");
*/
/*!
+ \property QInstaller::Component::treeName
+
+ \brief The tree name of the component. Specifies the location of the component in the install tree view.
+
+ \note If the tree name is not set, the tree view is organized based on the component name.
+
+ \note Must be unique, the tree name must not conflict with other component's names or tree names.
+*/
+
+/*!
\fn QInstaller::Component::loaded()
\sa {component::loaded}{component.loaded}
diff --git a/src/libs/kdtools/localpackagehub.cpp b/src/libs/kdtools/localpackagehub.cpp
index 9d35a9d1d..1a754d7d5 100644
--- a/src/libs/kdtools/localpackagehub.cpp
+++ b/src/libs/kdtools/localpackagehub.cpp
@@ -304,6 +304,7 @@ void LocalPackageHub::refresh()
Marks the package specified by \a name as installed. Sets the values of
\a version,
\a title,
+ \a treeName,
\a description,
\a dependencies,
\a autoDependencies,
diff --git a/src/libs/kdtools/updateoperation.cpp b/src/libs/kdtools/updateoperation.cpp
index 35c9dce2e..00b059af1 100644
--- a/src/libs/kdtools/updateoperation.cpp
+++ b/src/libs/kdtools/updateoperation.cpp
@@ -68,6 +68,18 @@ using namespace KDUpdater;
to get the human-readable description of the error that occurred.
*/
+/*!
+ \enum UpdateOperation::OperationType
+ This enum code specifies the operation type.
+
+ \value Backup
+ Backup operation.
+ \value Perform
+ Perform operation.
+ \value Undo
+ Undo operation.
+*/
+
/*
\internal
Returns a filename for a temporary file based on \a templateName.