Skip to content

Commit 5d11d13

Browse files
committed
small doc changes
1 parent 811bcc7 commit 5d11d13

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

AutoUpdater/updater.dox

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,18 @@ independet of the Widgets-Library and won't need a gui. The Widgets-Library requ
99
a gui and the Core-Library.
1010

1111
## Core-Library:
12-
- Updater : The main updater class
13-
- UpdateScheduler : Responsilbe for update-scheduling. Internal class, indirectly accessible
14-
by the Updater (and UpdateController)
15-
- UpdateTask : Base class for all update tasks. The most useful are:
16-
- TimeSpan : Represents a timespan with a timeunit
17-
- BasicLoopUpdateTask : An (optinally) repeated timespan
18-
- TimePointUpdateTask : A specific timepoint (with optional repeating every year/month/...)
19-
- UpdateTaskList : An abstract list of different sequential update tasks
12+
- Updater
13+
- UpdateSchedulerController
14+
- TimeSpan
15+
- UpdateTask
16+
- LoopUpdateTask
17+
- BasicLoopUpdateTask
18+
- TimePointUpdateTask
19+
- UpdateTaskList
20+
- AdminAuthoriser
2021

2122
## Widgets-Libray:
22-
- UpdateController : A gui-controller to automate the update process and show information to the user
23+
- UpdateController
2324
*/
2425

2526
/*!

AutoUpdater/updateschedulercontroller.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ shure that QCoreApplication::applicationName (and QCoreApplication::organization
1414
are set properly or use UpdateSchedulerController::setSettingsObject for a custom settings
1515
object.
1616

17-
@sa Updater::scheduleUpdate(UpdateTask *), UpdateController::scheduleUpdate(UpdateTask *),
17+
@sa Updater::scheduleUpdate(UpdateTask *), UpdateController::scheduleUpdate(UpdateTask *, DisplayLevel),
1818
QSettings::QSettings(QObject *)
1919
*/
2020

AutoUpdaterWidgets/updatecontroller.dox

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,15 @@ UpdateController::maintenanceToolPath for more details.
272272
@sa QObject::parent, UpdateController::setParent(QObject *), UpdateController::maintenanceToolPath
273273
*/
274274

275+
/*!
276+
@fn QtAutoUpdater::UpdateController::~UpdateController
277+
278+
@warning Do not destroy the controller while UpdateController::running returns `true`!!!
279+
This will crash your program!!!
280+
281+
@sa UpdateController::running, UpdateController::cancelUpdate
282+
*/
283+
275284
/*!
276285
@fn QtAutoUpdater::UpdateController::UpdateController(const QString &, QWidget *)
277286

0 commit comments

Comments
 (0)