diff options
author | Martin Smith <martin.smith@qt.io> | 2018-08-10 12:14:05 +0200 |
---|---|---|
committer | Martin Smith <martin.smith@qt.io> | 2018-08-14 17:54:55 +0000 |
commit | 109af99261f3a3fd05954ba0f6e01b83c19dcf81 (patch) | |
tree | a4c36cf6eedfae81e6ffa9583ddfa9e4fa22a9e3 /src/widgets/widgets/qspinbox.cpp | |
parent | 30e26d258bc69018b7dd6517d816cf36d5606bd3 (diff) |
qdoc: Fix several minor errors to reduce qdoc warnings
This update corrects several minor documentation errors that
cause qdoc warnings. These include incorrect or missing \fn
commands, incorrect uses of \e and \a commands together,
incorrect spellings, etc.
Change-Id: Ib26edef541fa3440025490bcf79cc101623e7f7b
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/widgets/widgets/qspinbox.cpp')
-rw-r--r-- | src/widgets/widgets/qspinbox.cpp | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/src/widgets/widgets/qspinbox.cpp b/src/widgets/widgets/qspinbox.cpp index 7f29c0c52c..dcf3906dd7 100644 --- a/src/widgets/widgets/qspinbox.cpp +++ b/src/widgets/widgets/qspinbox.cpp @@ -421,8 +421,8 @@ void QSpinBox::setRange(int minimum, int maximum) } /*! - Sets the step type for the spin box: single step or adaptive - decimal step. + Sets the step type for the spin box to \a stepType, which is single + step or adaptive decimal step. Adaptive decimal step means that the step size will continuously be adjusted to one power of ten below the current \l value. So when @@ -439,7 +439,6 @@ void QSpinBox::setRange(int minimum, int maximum) \l singleStep, although it is preserved so that \l singleStep comes into effect if adaptive decimal step is later turned off. - \sa QAbstractSpinBox::groupSeparator() \since 5.12 */ @@ -449,6 +448,13 @@ void QSpinBox::setStepType(QAbstractSpinBox::StepType stepType) d->stepType = stepType; } +/*! + \property QSpinBox::stepType + \brief The step type. + + The step type can be single step or adaptive decimal step. +*/ + QAbstractSpinBox::StepType QSpinBox::stepType() const { Q_D(const QSpinBox); @@ -888,8 +894,8 @@ void QDoubleSpinBox::setRange(double minimum, double maximum) } /*! - Sets the step type for the spin box: single step or adaptive - decimal step. + Sets the step type for the spin box to \a stepType, which is single + step or adaptive decimal step. Adaptive decimal step means that the step size will continuously be adjusted to one power of ten below the current \l value. So when @@ -909,7 +915,6 @@ void QDoubleSpinBox::setRange(double minimum, double maximum) \l singleStep, although it is preserved so that \l singleStep comes into effect if adaptive decimal step is later turned off. - \sa QAbstractSpinBox::groupSeparator() \since 5.12 */ @@ -919,6 +924,13 @@ void QDoubleSpinBox::setStepType(StepType stepType) d->stepType = stepType; } +/*! + \property QDoubleSpinBox::stepType + \brief The step type. + + The step type can be single step or adaptive decimal step. +*/ + QAbstractSpinBox::StepType QDoubleSpinBox::stepType() const { Q_D(const QDoubleSpinBox); |