Widgets/doc remove all \since 4.x comments in widgets/dialogs

Remove all \since 4.x comments in widgets/dialogs - this is no longer
of interest.

Pick-to: 6.8
Change-Id: I4835be8c16363b13615ffc921454e2b5ade295eb
Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
This commit is contained in:
Christian Ehrlicher 2024-08-20 20:31:46 +02:00
parent e279dd8c20
commit b5bb8897d0
9 changed files with 0 additions and 162 deletions

View File

@ -516,8 +516,6 @@ int QColorDialog::customCount()
}
/*!
\since 4.5
Returns the custom color at the given \a index as a QColor value.
*/
QColor QColorDialog::customColor(int index)
@ -1974,8 +1972,6 @@ static const Qt::WindowFlags qcd_DefaultWindowFlags =
*/
/*!
\since 4.5
Constructs a color dialog with the given \a parent.
*/
QColorDialog::QColorDialog(QWidget *parent)
@ -1984,8 +1980,6 @@ QColorDialog::QColorDialog(QWidget *parent)
}
/*!
\since 4.5
Constructs a color dialog with the given \a parent and specified
\a initial color.
*/
@ -2056,8 +2050,6 @@ void QColorDialog::setOption(ColorDialogOption option, bool on)
}
/*!
\since 4.5
Returns \c true if the given \a option is enabled; otherwise, returns
false.
@ -2110,8 +2102,6 @@ QColorDialog::ColorDialogOptions QColorDialog::options() const
/*!
\enum QColorDialog::ColorDialogOption
\since 4.5
This enum specifies various options that affect the look and feel
of a color dialog.
@ -2182,8 +2172,6 @@ void QColorDialogPrivate::setVisible(bool visible)
}
/*!
\since 4.5
Opens the dialog and connects its colorSelected() signal to the slot specified
by \a receiver and \a member.
@ -2199,8 +2187,6 @@ void QColorDialog::open(QObject *receiver, const char *member)
}
/*!
\since 4.5
Pops up a modal color dialog with the given window \a title (or "Select Color" if none is
specified), lets the user choose a color, and returns that color. The color is initially set
to \a initial. The dialog is a child of \a parent. It returns an invalid (see

View File

@ -493,8 +493,6 @@ void QDialog::setResult(int r)
}
/*!
\since 4.5
Shows the dialog as a \l{QDialog#Modal Dialogs}{window modal dialog},
returning immediately.
@ -1066,7 +1064,6 @@ void QDialog::resizeEvent(QResizeEvent *)
}
/*! \fn void QDialog::finished(int result)
\since 4.1
This signal is emitted when the dialog's \a result code has been
set, either by the user or by calling done(), accept(), or
@ -1080,7 +1077,6 @@ void QDialog::resizeEvent(QResizeEvent *)
*/
/*! \fn void QDialog::accepted()
\since 4.1
This signal is emitted when the dialog has been accepted either by
the user or by calling accept() or done() with the
@ -1094,7 +1090,6 @@ void QDialog::resizeEvent(QResizeEvent *)
*/
/*! \fn void QDialog::rejected()
\since 4.1
This signal is emitted when the dialog has been rejected either by
the user or by calling reject() or done() with the

View File

@ -383,7 +383,6 @@ void QErrorMessage::showMessage(const QString &message)
}
/*!
\since 4.5
\overload
Shows the given message, \a message, and returns immediately. If the user

View File

@ -296,7 +296,6 @@ Q_GLOBAL_STATIC(QUrl, lastVisitedDir)
/*!
\fn void QFileDialog::directoryEntered(const QString &directory)
\since 4.3
This signal is emitted for local operations when the user enters
a \a directory.
@ -312,7 +311,6 @@ Q_GLOBAL_STATIC(QUrl, lastVisitedDir)
/*!
\fn void QFileDialog::filterSelected(const QString &filter)
\since 4.3
This signal is emitted when the user selects a \a filter.
*/
@ -382,7 +380,6 @@ QFileDialog::~QFileDialog()
}
/*!
\since 4.3
Sets the \a urls that are located in the sidebar.
For instance:
@ -403,7 +400,6 @@ void QFileDialog::setSidebarUrls(const QList<QUrl> &urls)
}
/*!
\since 4.3
Returns a list of urls that are currently in the sidebar
*/
QList<QUrl> QFileDialog::sidebarUrls() const
@ -415,7 +411,6 @@ QList<QUrl> QFileDialog::sidebarUrls() const
static const qint32 QFileDialogMagic = 0xbe;
/*!
\since 4.3
Saves the state of the dialog's layout, history and current directory.
Typically this is used in conjunction with QSettings to remember the size
@ -449,7 +444,6 @@ QByteArray QFileDialog::saveState() const
}
/*!
\since 4.3
Restores the dialogs's layout, history and current directory to the \a state specified.
Typically this is used in conjunction with QSettings to restore the size
@ -713,7 +707,6 @@ bool QFileDialogPrivate::usingWidgets() const
}
/*!
\since 4.5
Sets the given \a option to be enabled if \a on is true; otherwise,
clears the given \a option.
@ -737,8 +730,6 @@ void QFileDialog::setOption(Option option, bool on)
}
/*!
\since 4.5
Returns \c true if the given \a option is enabled; otherwise, returns
false.
@ -753,7 +744,6 @@ bool QFileDialog::testOption(Option option) const
/*!
\property QFileDialog::options
\brief The various options that affect the look and feel of the dialog.
\since 4.5
By default, all options are disabled.
@ -824,8 +814,6 @@ QFileDialog::Options QFileDialog::options() const
}
/*!
\since 4.5
This function shows the dialog, and connects the slot specified by \a receiver
and \a member to the signal that informs about selection changes. If the fileMode is
ExistingFiles, this is the filesSelected() signal, otherwise it is the fileSelected() signal.
@ -1358,8 +1346,6 @@ QStringList qt_make_filter_list(const QString &filter)
}
/*!
\since 4.4
Sets the filter used in the file dialog to the given \a filter.
If \a filter contains a pair of parentheses containing one or more
@ -1404,8 +1390,6 @@ QStringList qt_strip_filters(const QStringList &filters)
/*!
\since 4.4
Sets the \a filters used in the file dialog.
Note that the filter \b{*.*} is not portable, because the historical
@ -1448,8 +1432,6 @@ void QFileDialog::setNameFilters(const QStringList &filters)
}
/*!
\since 4.4
Returns the file type filters that are in operation on this file
dialog.
*/
@ -1459,8 +1441,6 @@ QStringList QFileDialog::nameFilters() const
}
/*!
\since 4.4
Sets the current file type \a filter. Multiple filters can be
passed in \a filter by separating them with semicolons or spaces.
@ -1489,8 +1469,6 @@ void QFileDialog::selectNameFilter(const QString &filter)
}
/*!
\since 4.4
Returns the filter that the user selected in the file dialog.
\sa selectedFiles()
@ -1505,8 +1483,6 @@ QString QFileDialog::selectedNameFilter() const
}
/*!
\since 4.4
Returns the filter that is used when displaying files.
\sa setFilter()
@ -1520,8 +1496,6 @@ QDir::Filters QFileDialog::filter() const
}
/*!
\since 4.4
Sets the filter used by the model to \a filters. The filter is used
to specify the kind of files that should be shown.
@ -3164,8 +3138,6 @@ void QFileDialogPrivate::showHeader(QAction *action)
#if QT_CONFIG(proxymodel)
/*!
\since 4.3
Sets the model for the views to the given \a proxyModel. This is useful if you
want to modify the underlying model; for example, to add columns, filter
data or add drives.

View File

@ -108,8 +108,6 @@ QFontDialogPrivate::~QFontDialogPrivate()
*/
/*!
\since 4.5
Constructs a standard font dialog.
Use setCurrentFont() to set the initial font attributes.
@ -126,8 +124,6 @@ QFontDialog::QFontDialog(QWidget *parent)
}
/*!
\since 4.5
Constructs a standard font dialog with the given \a parent and specified
\a initial font.
*/
@ -773,15 +769,11 @@ void QFontDialog::changeEvent(QEvent *e)
}
/*!
\since 4.5
\property QFontDialog::currentFont
\brief the current font of the dialog.
*/
/*!
\since 4.5
Sets the font highlighted in the QFontDialog to the given \a font.
\sa selectedFont()
@ -807,8 +799,6 @@ void QFontDialog::setCurrentFont(const QFont &font)
}
/*!
\since 4.5
Returns the current font.
\sa selectedFont()
@ -840,7 +830,6 @@ QFont QFontDialog::selectedFont() const
/*!
\enum QFontDialog::FontDialogOption
\since 4.5
This enum specifies various options that affect the look and feel
of a font dialog.
@ -891,7 +880,6 @@ bool QFontDialog::testOption(FontDialogOption option) const
/*!
\property QFontDialog::options
\brief the various options that affect the look and feel of the dialog
\since 4.5
By default, all options are disabled.
@ -919,8 +907,6 @@ QFontDialog::FontDialogOptions QFontDialog::options() const
}
/*!
\since 4.5
Opens the dialog and connects its fontSelected() signal to the slot specified
by \a receiver and \a member.
@ -936,8 +922,6 @@ void QFontDialog::open(QObject *receiver, const char *member)
}
/*!
\since 4.5
\fn void QFontDialog::currentFontChanged(const QFont &font)
This signal is emitted when the current font is changed. The new font is
@ -950,8 +934,6 @@ void QFontDialog::open(QObject *receiver, const char *member)
*/
/*!
\since 4.5
\fn void QFontDialog::fontSelected(const QFont &font)
This signal is emitted when a font has been selected. The selected font is

View File

@ -471,7 +471,6 @@ void QInputDialogPrivate::currentRowChanged(const QModelIndex &newIndex,
/*!
\enum QInputDialog::InputMode
\since 4.5
This enum describes the different modes of input that can be selected for
the dialog.
@ -485,8 +484,6 @@ void QInputDialogPrivate::currentRowChanged(const QModelIndex &newIndex,
*/
/*!
\since 4.5
Constructs a new input dialog with the given \a parent and window \a flags.
*/
QInputDialog::QInputDialog(QWidget *parent, Qt::WindowFlags flags)
@ -495,8 +492,6 @@ QInputDialog::QInputDialog(QWidget *parent, Qt::WindowFlags flags)
}
/*!
\since 4.5
Destroys the input dialog.
*/
QInputDialog::~QInputDialog()
@ -504,8 +499,6 @@ QInputDialog::~QInputDialog()
}
/*!
\since 4.5
\property QInputDialog::inputMode
\brief the mode used for input
@ -559,8 +552,6 @@ QInputDialog::InputMode QInputDialog::inputMode() const
}
/*!
\since 4.5
\property QInputDialog::labelText
\brief the label's text which describes what needs to be input
@ -585,8 +576,6 @@ QString QInputDialog::labelText() const
/*!
\enum QInputDialog::InputDialogOption
\since 4.5
This enum specifies various options that affect the look and feel
of an input dialog.
@ -627,7 +616,6 @@ bool QInputDialog::testOption(InputDialogOption option) const
/*!
\property QInputDialog::options
\brief the various options that affect the look and feel of the dialog
\since 4.5
By default, all options are disabled.
@ -659,8 +647,6 @@ QInputDialog::InputDialogOptions QInputDialog::options() const
}
/*!
\since 4.5
\property QInputDialog::textValue
\brief the text value for the input dialog
@ -691,8 +677,6 @@ QString QInputDialog::textValue() const
}
/*!
\since 4.5
\property QInputDialog::textEchoMode
\brief the echo mode for the text value
@ -718,8 +702,6 @@ QLineEdit::EchoMode QInputDialog::textEchoMode() const
}
/*!
\since 4.5
\property QInputDialog::comboBoxEditable
\brief whether or not the combo box used in the input dialog is editable
@ -744,8 +726,6 @@ bool QInputDialog::isComboBoxEditable() const
}
/*!
\since 4.5
\property QInputDialog::comboBoxItems
\brief the items used in the combo box for the input dialog
@ -780,7 +760,6 @@ QStringList QInputDialog::comboBoxItems() const
/*!
\property QInputDialog::intValue
\since 4.5
\brief the current integer value accepted as input
This property is only relevant when the input dialog is used in
@ -805,7 +784,6 @@ int QInputDialog::intValue() const
/*!
\property QInputDialog::intMinimum
\since 4.5
\brief the minimum integer value accepted as input
This property is only relevant when the input dialog is used in
@ -830,7 +808,6 @@ int QInputDialog::intMinimum() const
/*!
\property QInputDialog::intMaximum
\since 4.5
\brief the maximum integer value accepted as input
This property is only relevant when the input dialog is used in
@ -867,7 +844,6 @@ void QInputDialog::setIntRange(int min, int max)
/*!
\property QInputDialog::intStep
\since 4.5
\brief the step by which the integer value is increased and decreased
This property is only relevant when the input dialog is used in
@ -892,7 +868,6 @@ int QInputDialog::intStep() const
/*!
\property QInputDialog::doubleValue
\since 4.5
\brief the current double precision floating point value accepted as input
This property is only relevant when the input dialog is used in
@ -917,7 +892,6 @@ double QInputDialog::doubleValue() const
/*!
\property QInputDialog::doubleMinimum
\since 4.5
\brief the minimum double precision floating point value accepted as input
This property is only relevant when the input dialog is used in
@ -942,7 +916,6 @@ double QInputDialog::doubleMinimum() const
/*!
\property QInputDialog::doubleMaximum
\since 4.5
\brief the maximum double precision floating point value accepted as input
This property is only relevant when the input dialog is used in
@ -978,8 +951,6 @@ void QInputDialog::setDoubleRange(double min, double max)
}
/*!
\since 4.5
\property QInputDialog::doubleDecimals
\brief sets the precision of the double spinbox in decimals
@ -1004,8 +975,6 @@ int QInputDialog::doubleDecimals() const
}
/*!
\since 4.5
\property QInputDialog::okButtonText
\brief the text for the button used to accept the entry in the dialog
@ -1025,8 +994,6 @@ QString QInputDialog::okButtonText() const
}
/*!
\since 4.5
\property QInputDialog::cancelButtonText
\brief the text for the button used to cancel the dialog
*/
@ -1045,8 +1012,6 @@ QString QInputDialog::cancelButtonText() const
}
/*!
\since 4.5
This function connects one of its signals to the slot specified by \a receiver
and \a member. The specific signal depends on the arguments that are specified
in \a member. These are:
@ -1240,8 +1205,6 @@ QString QInputDialog::getMultiLineText(QWidget *parent, const QString &title, co
}
/*!
\since 4.5
Static convenience function to get an integer input from the user.
\a title is the text which is displayed in the title bar of the dialog.

View File

@ -761,7 +761,6 @@ void QMessageBoxPrivate::helperClicked(QPlatformDialogHelper::StandardButton hel
/*!
\enum QMessageBox::StandardButton
\since 4.2
These enums describe flags for standard buttons. Each button has a
defined \l ButtonRole.
@ -880,8 +879,6 @@ QMessageBox::~QMessageBox()
}
/*!
\since 4.2
Adds the given \a button to the message box with the specified \a
role.
@ -927,7 +924,6 @@ QMessageBox::StandardButton QMessageBoxPrivate::standardButtonForRole(QMessageBo
}
/*!
\since 4.2
\overload
Creates a button with the given \a text, adds it to the message box for the
@ -943,7 +939,6 @@ QPushButton *QMessageBox::addButton(const QString& text, ButtonRole role)
}
/*!
\since 4.2
\overload
Adds a standard \a button to the message box if it is valid to do so, and
@ -961,8 +956,6 @@ QPushButton *QMessageBox::addButton(StandardButton button)
}
/*!
\since 4.2
Removes \a button from the button box without deleting it.
\sa addButton(), setStandardButtons()
@ -982,7 +975,6 @@ void QMessageBox::removeButton(QAbstractButton *button)
/*!
\property QMessageBox::standardButtons
\brief collection of standard buttons in the message box
\since 4.2
This property controls which standard buttons are used by the message box.
@ -1011,8 +1003,6 @@ QMessageBox::StandardButtons QMessageBox::standardButtons() const
}
/*!
\since 4.2
Returns the standard button enum value corresponding to the given \a button,
or NoButton if the given \a button isn't a standard button.
@ -1025,8 +1015,6 @@ QMessageBox::StandardButton QMessageBox::standardButton(QAbstractButton *button)
}
/*!
\since 4.2
Returns a pointer corresponding to the standard button \a which,
or \nullptr if the standard button doesn't exist in this message box.
@ -1045,8 +1033,6 @@ QAbstractButton *QMessageBox::button(StandardButton which) const
}
/*!
\since 4.2
Returns the button that is activated when escape is pressed.
By default, QMessageBox attempts to automatically detect an
@ -1071,8 +1057,6 @@ QAbstractButton *QMessageBox::escapeButton() const
}
/*!
\since 4.2
Sets the button that gets activated when the \uicontrol Escape key is
pressed to \a button.
@ -1086,8 +1070,6 @@ void QMessageBox::setEscapeButton(QAbstractButton *button)
}
/*!
\since 4.3
Sets the buttons that gets activated when the \uicontrol Escape key is
pressed to \a button.
@ -1154,8 +1136,6 @@ void QMessageBoxPrivate::detectEscapeButton()
}
/*!
\since 4.2
Returns the button that was clicked by the user,
or \nullptr if the user hit the \uicontrol Esc key and
no \l{setEscapeButton()}{escape button} was set.
@ -1175,8 +1155,6 @@ QAbstractButton *QMessageBox::clickedButton() const
}
/*!
\since 4.2
Returns the button that should be the message box's
\l{QPushButton::setDefault()}{default button}. Returns nullptr
if no default button was set.
@ -1190,8 +1168,6 @@ QPushButton *QMessageBox::defaultButton() const
}
/*!
\since 4.2
Sets the message box's \l{QPushButton::setDefault()}{default button}
to \a button.
@ -1208,8 +1184,6 @@ void QMessageBox::setDefaultButton(QPushButton *button)
}
/*!
\since 4.3
Sets the message box's \l{QPushButton::setDefault()}{default button}
to \a button.
@ -1702,8 +1676,6 @@ void QMessageBoxPrivate::setVisible(bool visible)
}
/*!
\since 4.5
Returns a list of all the buttons that have been added to the message box.
\sa buttonRole(), addButton(), removeButton()
@ -1715,8 +1687,6 @@ QList<QAbstractButton *> QMessageBox::buttons() const
}
/*!
\since 4.5
Returns the button role for the specified \a button. This function returns
\l InvalidRole if \a button is \nullptr or has not been added to the message box.
@ -1792,8 +1762,6 @@ static QMessageBox::StandardButton showNewMessageBox(QWidget *parent,
}
/*!
\since 4.2
Opens an information message box with the given \a title and
\a text in front of the specified \a parent widget.
@ -1826,8 +1794,6 @@ QMessageBox::StandardButton QMessageBox::information(QWidget *parent, const QStr
/*!
\since 4.2
Opens a question message box with the given \a title and \a
text in front of the specified \a parent widget.
@ -1858,8 +1824,6 @@ QMessageBox::StandardButton QMessageBox::question(QWidget *parent, const QString
}
/*!
\since 4.2
Opens a warning message box with the given \a title and \a
text in front of the specified \a parent widget.
@ -1890,8 +1854,6 @@ QMessageBox::StandardButton QMessageBox::warning(QWidget *parent, const QString
}
/*!
\since 4.2
Opens a critical message box with the given \a title and \a
text in front of the specified \a parent widget.
@ -2630,7 +2592,6 @@ void QMessageBox::setButtonText(int button, const QString &text)
/*!
\property QMessageBox::detailedText
\brief the text to be displayed in the details area.
\since 4.2
The text will be interpreted as a plain text.
@ -2682,8 +2643,6 @@ void QMessageBox::setDetailedText(const QString &text)
\brief the informative text that provides a fuller description for
the message
\since 4.2
Informative text can be used to expand upon the text() to give more
information to the user, for example describing the consequences of
the situation, or suggestion alternative solutions.
@ -2733,8 +2692,6 @@ void QMessageBox::setInformativeText(const QString &text)
}
/*!
\since 4.2
This function shadows QWidget::setWindowTitle().
Sets the title of the message box to \a title. On \macos,
@ -2753,8 +2710,6 @@ void QMessageBox::setWindowTitle(const QString &title)
/*!
\since 4.2
This function shadows QWidget::setWindowModality().
Sets the modality of the message box to \a windowModality.

View File

@ -820,8 +820,6 @@ void QProgressDialog::forceShow()
}
/*!
\since 4.5
Opens the dialog and connects its canceled() signal to the slot specified
by \a receiver and \a member.

View File

@ -1737,7 +1737,6 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *)
/*!
\class QWizard
\since 4.3
\brief The QWizard class provides a framework for wizards.
\inmodule QtWidgets
@ -2218,7 +2217,6 @@ void QWizard::setPage(int theid, QWizardPage *page)
\note Removing a page may influence the value of the startId property.
\since 4.5
\sa addPage(), setPage(), pageRemoved(), startId()
*/
void QWizard::removePage(int id)
@ -2333,7 +2331,6 @@ QList<int> QWizard::visitedIds() const
/*!
Returns the list of page IDs.
\since 4.5
*/
QList<int> QWizard::pageIds() const
{
@ -2860,8 +2857,6 @@ void QWizard::setDefaultProperty(const char *className, const char *property,
}
/*!
\since 4.7
Sets the given \a widget to be shown on the left side of the wizard.
For styles which use the WatermarkPixmap (ClassicStyle and ModernStyle)
the side widget is displayed on top of the watermark, for other styles
@ -2895,8 +2890,6 @@ void QWizard::setSideWidget(QWidget *widget)
}
/*!
\since 4.7
Returns the widget on the left side of the wizard or \nullptr.
By default, no side widget is present.
@ -2960,8 +2953,6 @@ QSize QWizard::sizeHint() const
/*!
\fn void QWizard::pageAdded(int id)
\since 4.7
This signal is emitted whenever a page is added to the
wizard. The page's \a id is passed as parameter.
@ -2971,8 +2962,6 @@ QSize QWizard::sizeHint() const
/*!
\fn void QWizard::pageRemoved(int id)
\since 4.7
This signal is emitted whenever a page is removed from the
wizard. The page's \a id is passed as parameter.
@ -3335,7 +3324,6 @@ int QWizard::nextId() const
/*!
\class QWizardPage
\since 4.3
\brief The QWizardPage class is the base class for wizard pages.
\inmodule QtWidgets