Skip to content

Commit 67361a0

Browse files
committed
added full UpdateButton documentation
1 parent d3c0bf4 commit 67361a0

13 files changed

+25
-1
lines changed

AutoUpdaterGui/updatebutton.dox

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,30 @@ happens is nothing: The button will be there, but just nothing happens if it is
8484
@notifyAc{controllerChanged()}
8585
}
8686

87-
@sa QtAutoUpdater::UpdateController, UpdateController::resetState
87+
@sa QtAutoUpdater::UpdateController, UpdateButton::resetState
88+
*/
89+
90+
/*!
91+
@fn QtAutoUpdater::UpdateButton::UpdateButton
92+
93+
@param parent The parent widget of the button
94+
@param controller The UpdateController to be used by the button
95+
96+
If `controller` is `nullptr`, the button will be disabled until you set a controller manually.
97+
98+
@sa UpdateButton::controller
99+
*/
100+
101+
/*!
102+
@fn QtAutoUpdater::UpdateButton::resetState
103+
104+
The button will look like it looks after it's creation. Any progress or message will be reset.
105+
However, if the UpdateButton itself is disabled because of a missing controller, this will not be
106+
reset. Neither will the animation file or the display level be reset.
107+
108+
@note Calling this slot while the updater is running will still reset the button, but after the updater
109+
has finished, the button will show the result (if enabled).
110+
111+
@sa UpdateButton::showResult, UpdateButton::animationFile, UpdateController::running
88112
*/
89113

0 commit comments

Comments
 (0)