kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-01-10 07:59:58 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix some doxygen issues (~100)

Browse Source
This commit is contained in:
Simon De Backer
2020-08-18 20:07:55 +02:00
parent b5f212418c
commit 790cdc5229
22 changed files with 205 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
sources/QWidgetAnimation/qwidgetanimation.cpp
View File

@@ -22,7 +22,8 @@
@brief QWidgetAnimation::QWidgetAnimation
@param widget : widget to animate
@param orientation : animate widget horizontally or vertically
@param duration : the duration of animation @see void QVariantAnimation::setDuration(int msecs)
@param duration : the duration of animation
@see void QVariantAnimation::setDuration(int msecs)
*/
QWidgetAnimation::QWidgetAnimation(QWidget *widget, Qt::Orientation orientation, QWidgetAnimation::Behavior behavior, int duration) :
QPropertyAnimation(widget),
@@ -149,7 +150,7 @@ void QWidgetAnimation::setHidden(bool hidden)
/**
@brief QWidgetAnimation::setLastShowSize
Force the last show size value to @size
Force the last show size value to size
@param size
*/
void QWidgetAnimation::setLastShowSize(int size)

23
sources/QWidgetAnimation/qwidgetanimation.h
View File

@@ -25,15 +25,22 @@
/**
@brief The QWidgetAnimation class
This class animate the show and hide function of a QWidget.
*
The role of @behavior is to calcul as best the animation process when widget is show.
Because this class don't change the current and final size of the widget but her maximum size during the animation process,
The role of behavior is to calcul as best the animation process
when widget is show.
Because this class don't change the current and final size
of the widget but her maximum size during the animation process,
we must to know in advance the final size of the widget.
Behavior minimumSizeHint : the final size of the widget will be his minimum size hint.
Behavior availableSpace : the final size of widget will be the available size of her parent.
Since parent can have other widgets you can add a QVector of widget to subtract of the final size.
Because we suppose the animated widget will take the maximum available space, we subtract the minimum size hint of widgets in QVector.
Behavior lastSize : The widget will have the same size as the last time he was showed.
Behavior minimumSizeHint : the final size of the widget
will be his minimum size hint.
Behavior availableSpace : the final size of widget will be
the available size of her parent.
Since parent can have other widgets you can add a QVector of widget
to subtract of the final size.
Because we suppose the animated widget will take the maximum
available space, we subtract the minimum size hint of widgets in QVector.
Behavior lastSize :
The widget will have the same size as the last time he was showed.
*/
class QWidgetAnimation : public QPropertyAnimation
{