path: root/src/widgets/dialogs
diff options
authorCasper van Donderen <>2011-09-20 23:22:36 +0200
committerQt by Nokia <>2011-10-03 09:56:09 +0200
commite86df8cc4b6a522fac909687d48b269c7f5108b6 (patch)
tree3b3157049b3dabe3432052415237bf1c1765c89b /src/widgets/dialogs
parent7f57f2912569cb6e728cc14afae71923f83ad663 (diff)
Move the documentation for the classes to their modules.
All documented classes under src/widgets should now be under the QtWidgets module in the documentation. The QtPrintSupport classes should now be under the QtPrintSupport module in the documentation. Change-Id: I236b15443b8b93a61578a1d10f52b64dba938f29 Reviewed-on: Reviewed-by: Casper van Donderen <>
Diffstat (limited to 'src/widgets/dialogs')
10 files changed, 13 insertions, 4 deletions
diff --git a/src/widgets/dialogs/qcolordialog.cpp b/src/widgets/dialogs/qcolordialog.cpp
index ce3e54f1f3..027470f779 100644
--- a/src/widgets/dialogs/qcolordialog.cpp
+++ b/src/widgets/dialogs/qcolordialog.cpp
@@ -1683,6 +1683,7 @@ static const Qt::WindowFlags DefaultWindowFlags =
\brief The QColorDialog class provides a dialog widget for specifying colors.
\ingroup standard-dialogs
+ \inmodule QtWidgets
The color dialog's function is to allow users to choose colors.
For example, you might use this in a drawing program to allow the
diff --git a/src/widgets/dialogs/qdialog.cpp b/src/widgets/dialogs/qdialog.cpp
index 41b34a1065..03c5316c04 100644
--- a/src/widgets/dialogs/qdialog.cpp
+++ b/src/widgets/dialogs/qdialog.cpp
@@ -87,7 +87,7 @@ QT_BEGIN_NAMESPACE
\ingroup dialog-classes
\ingroup abstractwidgets
+ \inmodule QtWidgets
A dialog window is a top-level window mostly used for short-term
tasks and brief communications with the user. QDialogs may be
diff --git a/src/widgets/dialogs/qerrormessage.cpp b/src/widgets/dialogs/qerrormessage.cpp
index 890e6ca6b7..e87551cd80 100644
--- a/src/widgets/dialogs/qerrormessage.cpp
+++ b/src/widgets/dialogs/qerrormessage.cpp
@@ -151,6 +151,7 @@ QSize QErrorMessageTextView::sizeHint() const
\brief The QErrorMessage class provides an error message display dialog.
\ingroup standard-dialog
+ \inmodule QtWidgets
An error message widget consists of a text label and a checkbox. The
checkbox lets the user control whether the same error message will be
diff --git a/src/widgets/dialogs/qfiledialog.cpp b/src/widgets/dialogs/qfiledialog.cpp
index 3c2e134c9b..2a402f5691 100644
--- a/src/widgets/dialogs/qfiledialog.cpp
+++ b/src/widgets/dialogs/qfiledialog.cpp
@@ -96,7 +96,7 @@ Q_WIDGETS_EXPORT _qt_filedialog_save_filename_hook qt_filedialog_save_filename_h
\class QFileDialog
\brief The QFileDialog class provides a dialog that allow users to select files or directories.
\ingroup standard-dialogs
+ \inmodule QtWidgets
The QFileDialog class enables a user to traverse the file system in
order to select one or many files or a directory.
diff --git a/src/widgets/dialogs/qfilesystemmodel.cpp b/src/widgets/dialogs/qfilesystemmodel.cpp
index 82de3f724b..9de79e0e81 100644
--- a/src/widgets/dialogs/qfilesystemmodel.cpp
+++ b/src/widgets/dialogs/qfilesystemmodel.cpp
@@ -74,6 +74,7 @@ QT_BEGIN_NAMESPACE
\brief The QFileSystemModel class provides a data model for the local filesystem.
\ingroup model-view
+ \inmodule QtWidgets
This class provides access to the local filesystem, providing functions
for renaming and removing files and directories, and for creating new
diff --git a/src/widgets/dialogs/qfontdialog.cpp b/src/widgets/dialogs/qfontdialog.cpp
index df49fee9bb..62338d8a3e 100644
--- a/src/widgets/dialogs/qfontdialog.cpp
+++ b/src/widgets/dialogs/qfontdialog.cpp
@@ -117,6 +117,7 @@ static const Qt::WindowFlags DefaultWindowFlags =
\class QFontDialog
\ingroup standard-dialogs
+ \inmodule QtWidgets
\brief The QFontDialog class provides a dialog widget for selecting a font.
diff --git a/src/widgets/dialogs/qinputdialog.cpp b/src/widgets/dialogs/qinputdialog.cpp
index 5ca947ccbd..1c52282ad5 100644
--- a/src/widgets/dialogs/qinputdialog.cpp
+++ b/src/widgets/dialogs/qinputdialog.cpp
@@ -437,7 +437,7 @@ void QInputDialogPrivate::_q_currentRowChanged(const QModelIndex &newIndex,
\brief The QInputDialog class provides a simple convenience dialog to get a
single value from the user.
\ingroup standard-dialogs
+ \inmodule QtWidgets
The input value can be a string, a number or an item from a list. A label
must be set to tell the user what they should enter.
diff --git a/src/widgets/dialogs/qmessagebox.cpp b/src/widgets/dialogs/qmessagebox.cpp
index 8b6073d6d1..96b8e46570 100644
--- a/src/widgets/dialogs/qmessagebox.cpp
+++ b/src/widgets/dialogs/qmessagebox.cpp
@@ -492,7 +492,7 @@ void QMessageBoxPrivate::_q_buttonClicked(QAbstractButton *button)
the user or for asking the user a question and receiving an answer.
\ingroup standard-dialogs
+ \inmodule QtWidgets
A message box displays a primary \l{QMessageBox::text}{text} to
alert the user to a situation, an \l{QMessageBox::informativeText}
diff --git a/src/widgets/dialogs/qprogressdialog.cpp b/src/widgets/dialogs/qprogressdialog.cpp
index 8701dc10fb..4e31abf3e4 100644
--- a/src/widgets/dialogs/qprogressdialog.cpp
+++ b/src/widgets/dialogs/qprogressdialog.cpp
@@ -218,6 +218,7 @@ void QProgressDialogPrivate::_q_disconnectOnClose()
\class QProgressDialog
\brief The QProgressDialog class provides feedback on the progress of a slow operation.
\ingroup standard-dialogs
+ \inmodule QtWidgets
A progress dialog is used to give the user an indication of how long
diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp
index 83bdaa0e55..81e23fbb18 100644
--- a/src/widgets/dialogs/qwizard.cpp
+++ b/src/widgets/dialogs/qwizard.cpp
@@ -1785,6 +1785,8 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *)
\since 4.3
\brief The QWizard class provides a framework for wizards.
+ \inmodule QtWidgets
A wizard (also called an assistant on Mac OS X) is a special type
of input dialog that consists of a sequence of pages. A wizard's
purpose is to guide the user through a process step by step.
@@ -3340,6 +3342,8 @@ int QWizard::nextId() const
\since 4.3
\brief The QWizardPage class is the base class for wizard pages.
+ \inmodule QtWidgets
QWizard represents a wizard. Each page is a QWizardPage. When
you create your own wizards, you can use QWizardPage directly,
or you can subclass it for more control.