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/dialogs | |
| 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/dialogs')
| -rw-r--r-- | src/widgets/dialogs/qcolordialog.cpp | 2 | ||||
| -rw-r--r-- | src/widgets/dialogs/qinputdialog.cpp | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/src/widgets/dialogs/qcolordialog.cpp b/src/widgets/dialogs/qcolordialog.cpp index e6a8ec47a4..434cedfdb9 100644 --- a/src/widgets/dialogs/qcolordialog.cpp +++ b/src/widgets/dialogs/qcolordialog.cpp @@ -2170,7 +2170,7 @@ QColor QColorDialog::getColor(const QColor &initial, QWidget *parent, const QStr and an alpha channel (transparency) value. The color+alpha is initially set to \a initial. The dialog is a child of \a parent. - If \a ok is non-null, \e *\a ok is set to true if the user clicked + If \a ok is non-null, \e {*ok} is set to true if the user clicked \uicontrol{OK}, and to false if the user clicked Cancel. If the user clicks Cancel, the \a initial value is returned. diff --git a/src/widgets/dialogs/qinputdialog.cpp b/src/widgets/dialogs/qinputdialog.cpp index 5c6e0f45a5..9a9bd173bd 100644 --- a/src/widgets/dialogs/qinputdialog.cpp +++ b/src/widgets/dialogs/qinputdialog.cpp @@ -1180,7 +1180,7 @@ void QInputDialog::done(int result) \a inputMethodHints is the input method hints that will be used in the edit widget if an input method is active. - If \a ok is nonnull \e *\a ok will be set to true if the user pressed + If \a ok is nonnull \e {*ok} will be set to true if the user pressed \uicontrol OK and to false if the user pressed \uicontrol Cancel. The dialog's parent is \a parent. The dialog will be modal and uses the specified widget \a flags. @@ -1228,7 +1228,7 @@ QString QInputDialog::getText(QWidget *parent, const QString &title, const QStri \a inputMethodHints is the input method hints that will be used in the edit widget if an input method is active. - If \a ok is nonnull \e *\a ok will be set to true if the user pressed + If \a ok is nonnull \e {*ok} will be set to true if the user pressed \uicontrol OK and to false if the user pressed \uicontrol Cancel. The dialog's parent is \a parent. The dialog will be modal and uses the specified widget \a flags. @@ -1436,7 +1436,7 @@ double QInputDialog::getDouble(QWidget *parent, const QString &title, const QStr If \a editable is true the user can enter their own text; otherwise, the user may only select one of the existing items. - If \a ok is nonnull \e *\a ok will be set to true if the user pressed + If \a ok is nonnull \e {*ok} will be set to true if the user pressed \uicontrol OK and to false if the user pressed \uicontrol Cancel. The dialog's parent is \a parent. The dialog will be modal and uses the widget \a flags. |