Doc: Adding mark-up to boolean default values.

Default values should have mark-up to denote that they are code.
This commit changes:
-"property is true" to "property is \c true".
-"Returns true" to "Returns \c true".
-"property is false" to "property is \c false".
-"returns true" to "returns \c true".
-"returns false" to "returns \c false".

src/3rdparty and non-documentation instances were ignored.

Task-number: QTBUG-33360
Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

7 files changed, 31 insertions, 31 deletions

diff --git a/src/widgets/dialogs/qcolordialog.cpp b/src/widgets/dialogs/qcolordialog.cpp
index 82f70f323b..d20725fc89 100644
--- a/src/widgets/dialogs/qcolordialog.cpp
+++ b/src/widgets/dialogs/qcolordialog.cpp
@@ -1889,7 +1889,7 @@ void QColorDialog::setOption(ColorDialogOption option, bool on)
 /*!
     \since 4.5
 
-    Returns true if the given \a option is enabled; otherwise, returns
+    Returns \c true if the given \a option is enabled; otherwise, returns
     false.
 
     \sa options, setOption()
diff --git a/src/widgets/dialogs/qdialog.cpp b/src/widgets/dialogs/qdialog.cpp
index e1097dd1bb..af352e45c6 100644
--- a/src/widgets/dialogs/qdialog.cpp
+++ b/src/widgets/dialogs/qdialog.cpp
@@ -1041,7 +1041,7 @@ QSize QDialog::minimumSizeHint() const
     \property QDialog::modal
     \brief whether show() should pop up the dialog as modal or modeless
 
-    By default, this property is false and show() pops up the dialog
+    By default, this property is \c false and show() pops up the dialog
     as modeless. Setting his property to true is equivalent to setting
     QWidget::windowModality to Qt::ApplicationModal.
 
diff --git a/src/widgets/dialogs/qfiledialog.cpp b/src/widgets/dialogs/qfiledialog.cpp
index 62cec34b2b..b688dfb0a4 100644
--- a/src/widgets/dialogs/qfiledialog.cpp
+++ b/src/widgets/dialogs/qfiledialog.cpp
@@ -490,7 +490,7 @@ QByteArray QFileDialog::saveState() const
     Typically this is used in conjunction with QSettings to restore the size
     from a past session.
 
-    Returns false if there are errors
+    Returns \c false if there are errors
 */
 bool QFileDialog::restoreState(const QByteArray &state)
 {
@@ -751,7 +751,7 @@ void QFileDialog::setOption(Option option, bool on)
 /*!
     \since 4.5
 
-    Returns true if the given \a option is enabled; otherwise, returns
+    Returns \c true if the given \a option is enabled; otherwise, returns
     false.
 
     \sa options, setOption()
@@ -1287,7 +1287,7 @@ void QFileDialog::setNameFilter(const QString &filter)
     \brief This property holds whether the filter details is shown or not.
     \since 4.4
 
-    When this property is true (the default), the filter details are shown
+    When this property is \c true (the default), the filter details are shown
     in the combo box.  When the property is set to false, these are hidden.
 
     Use setOption(HideNameFilterDetails, !\e enabled) or
@@ -3567,7 +3567,7 @@ void QFileDialogPrivate::_q_nativeEnterDirectory(const QUrl &directory)
 
     For the list and tree view watch keys to goto parent and back in the history
 
-    returns true if handled
+    returns \c true if handled
 */
 bool QFileDialogPrivate::itemViewKeyboardEvent(QKeyEvent *event) {
 
diff --git a/src/widgets/dialogs/qfilesystemmodel.cpp b/src/widgets/dialogs/qfilesystemmodel.cpp
index c86c7ff931..6330d529fb 100644
--- a/src/widgets/dialogs/qfilesystemmodel.cpp
+++ b/src/widgets/dialogs/qfilesystemmodel.cpp
@@ -482,8 +482,8 @@ void QFileSystemModel::timerEvent(QTimerEvent *event)
 }
 
 /*!
-    Returns true if the model item \a index represents a directory;
-    otherwise returns false.
+    Returns \c true if the model item \a index represents a directory;
+    otherwise returns \c false.
 */
 bool QFileSystemModel::isDir(const QModelIndex &index) const
 {
@@ -1531,7 +1531,7 @@ QDir::Filters QFileSystemModel::filter() const
 
     This is only relevant on Windows.
 
-    By default, this property is true.
+    By default, this property is \c true.
 */
 void QFileSystemModel::setResolveSymlinks(bool enable)
 {
@@ -1558,7 +1558,7 @@ bool QFileSystemModel::resolveSymlinks() const
     If this property is set to false, the directory model will allow renaming, copying
     and deleting of files and directories.
 
-    This property is true by default
+    This property is \c true by default
 */
 void QFileSystemModel::setReadOnly(bool enable)
 {
@@ -1576,7 +1576,7 @@ bool QFileSystemModel::isReadOnly() const
     \property QFileSystemModel::nameFilterDisables
     \brief Whether files that don't pass the name filter are hidden or disabled
 
-    This property is true by default
+    This property is \c true by default
 */
 void QFileSystemModel::setNameFilterDisables(bool enable)
 {
@@ -1971,7 +1971,7 @@ void QFileSystemModelPrivate::init()
 /*!
     \internal
 
-    Returns false if node doesn't pass the filters otherwise true
+    Returns \c false if node doesn't pass the filters otherwise true
 
     QDir::Modified is not supported
     QDir::Drives is not supported
@@ -2020,7 +2020,7 @@ bool QFileSystemModelPrivate::filtersAcceptsNode(const QFileSystemNode *node) co
 /*
     \internal
 
-    Returns true if node passes the name filters and should be visible.
+    Returns \c true if node passes the name filters and should be visible.
  */
 bool QFileSystemModelPrivate::passNameFilters(const QFileSystemNode *node) const
 {
diff --git a/src/widgets/dialogs/qfontdialog.cpp b/src/widgets/dialogs/qfontdialog.cpp
index b989ea7c86..d908a683a9 100644
--- a/src/widgets/dialogs/qfontdialog.cpp
+++ b/src/widgets/dialogs/qfontdialog.cpp
@@ -885,7 +885,7 @@ void QFontDialog::setOption(FontDialogOption option, bool on)
 }
 
 /*!
-    Returns true if the given \a option is enabled; otherwise, returns
+    Returns \c true if the given \a option is enabled; otherwise, returns
     false.
 
     \sa options, setOption()
diff --git a/src/widgets/dialogs/qinputdialog.cpp b/src/widgets/dialogs/qinputdialog.cpp
index c1f8deb4eb..4eec2eb3e2 100644
--- a/src/widgets/dialogs/qinputdialog.cpp
+++ b/src/widgets/dialogs/qinputdialog.cpp
@@ -629,7 +629,7 @@ void QInputDialog::setOption(InputDialogOption option, bool on)
 }
 
 /*!
-    Returns true if the given \a option is enabled; otherwise, returns
+    Returns \c true if the given \a option is enabled; otherwise, returns
     false.
 
     \sa options, setOption()
diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp
index 02d4d1ca27..02ad5a3be5 100644
--- a/src/widgets/dialogs/qwizard.cpp
+++ b/src/widgets/dialogs/qwizard.cpp
@@ -1963,7 +1963,7 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *)
     Another way is to reimplement validateCurrentPage() (or
     QWizardPage::validatePage()) to perform some last-minute
     validation (and show an error message if the user has entered
-    incomplete or invalid information). If the function returns true,
+    incomplete or invalid information). If the function returns \c true,
     the next page is shown (or the wizard finishes); otherwise, the
     current page stays up.
 
@@ -2331,8 +2331,8 @@ QWizardPage *QWizard::page(int theid) const
 /*!
     \fn bool QWizard::hasVisitedPage(int id) const
 
-    Returns true if the page history contains page \a id; otherwise,
-    returns false.
+    Returns \c true if the page history contains page \a id; otherwise,
+    returns \c false.
 
     Pressing \uicontrol Back marks the current page as "unvisited" again.
 
@@ -2544,7 +2544,7 @@ void QWizard::setOption(WizardOption option, bool on)
 }
 
 /*!
-    Returns true if the given \a option is enabled; otherwise, returns
+    Returns \c true if the given \a option is enabled; otherwise, returns
     false.
 
     \sa options, setOption(), setWizardStyle()
@@ -3276,7 +3276,7 @@ void QWizard::cleanupPage(int theid)
 /*!
     This virtual function is called by QWizard when the user clicks
     \uicontrol Next or \uicontrol Finish to perform some last-minute validation.
-    If it returns true, the next page is shown (or the wizard
+    If it returns \c true, the next page is shown (or the wizard
     finishes); otherwise, the current page stays up.
 
     The default implementation calls QWizardPage::validatePage() on
@@ -3363,7 +3363,7 @@ int QWizard::nextId() const
     \endlist
 
     Normally, the \uicontrol Next button and the \uicontrol Finish button of a
-    wizard are mutually exclusive. If isFinalPage() returns true, \uicontrol
+    wizard are mutually exclusive. If isFinalPage() returns \c true, \uicontrol
     Finish is available; otherwise, \uicontrol Next is available. By
     default, isFinalPage() is true only when nextId() returns -1. If
     you want to show \uicontrol Next and \uicontrol Final simultaneously for a
@@ -3566,10 +3566,10 @@ void QWizardPage::cleanupPage()
 /*!
     This virtual function is called by QWizard::validateCurrentPage()
     when the user clicks \uicontrol Next or \uicontrol Finish to perform some
-    last-minute validation. If it returns true, the next page is shown
+    last-minute validation. If it returns \c true, the next page is shown
     (or the wizard finishes); otherwise, the current page stays up.
 
-    The default implementation returns true.
+    The default implementation returns \c true.
 
     When possible, it is usually better style to disable the \uicontrol
     Next or \uicontrol Finish button (by specifying \l{mandatory fields} or
@@ -3587,8 +3587,8 @@ bool QWizardPage::validatePage()
     the \uicontrol Next or \uicontrol Finish button should be enabled or
     disabled.
 
-    The default implementation returns true if all \l{mandatory
-    fields} are filled; otherwise, it returns false.
+    The default implementation returns \c true if all \l{mandatory
+    fields} are filled; otherwise, it returns \c false.
 
     If you reimplement this function, make sure to emit completeChanged(),
     from the rest of your implementation, whenever the value of isComplete()
@@ -3634,12 +3634,12 @@ bool QWizardPage::isComplete() const
 /*!
     Explicitly sets this page to be final if \a finalPage is true.
 
-    After calling setFinalPage(true), isFinalPage() returns true and the \uicontrol
+    After calling setFinalPage(true), isFinalPage() returns \c true and the \uicontrol
     Finish button is visible (and enabled if isComplete() returns
     true).
 
-    After calling setFinalPage(false), isFinalPage() returns true if
-    nextId() returns -1; otherwise, it returns false.
+    After calling setFinalPage(false), isFinalPage() returns \c true if
+    nextId() returns -1; otherwise, it returns \c false.
 
     \sa isComplete(), QWizard::HaveFinishButtonOnEarlyPages
 */
@@ -3656,8 +3656,8 @@ void QWizardPage::setFinalPage(bool finalPage)
     This function is called by QWizard to determine whether the \uicontrol
     Finish button should be shown for this page or not.
 
-    By default, it returns true if there is no next page
-    (i.e., nextId() returns -1); otherwise, it returns false.
+    By default, it returns \c true if there is no next page
+    (i.e., nextId() returns -1); otherwise, it returns \c false.
 
     By explicitly calling setFinalPage(true), you can let the user perform an
     "early finish".
@@ -3703,7 +3703,7 @@ void QWizardPage::setCommitPage(bool commitPage)
 }
 
 /*!
-    Returns true if this page is a commit page; otherwise returns false.
+    Returns \c true if this page is a commit page; otherwise returns \c false.
 
     \sa setCommitPage()
 */