Doc: Normalize \since usage

Although it's permitted to specify the project name together with
a version number for \since, it's unnecessary for Qt classes and
functions.

This change also normalizes the version formatting: '<major>.<minor>'

Change-Id: Ie5a43662077d13c31e241bcde8a7a2849d27d330
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Topi Reinio 2017-01-02 10:58:10 +01:00 committed by Topi Reiniö
parent 41e4b4de91
commit 07218826e5
7 changed files with 14 additions and 10 deletions

View File

@ -131,7 +131,7 @@ Q_STATIC_ASSERT_X(QT_POINTER_SIZE == sizeof(void *), "QT_POINTER_SIZE defined in
/*!
\fn QFlag::QFlag(uint value)
\since Qt 5.3
\since 5.3
Constructs a QFlag object that stores the given \a value.
*/
@ -145,7 +145,7 @@ Q_STATIC_ASSERT_X(QT_POINTER_SIZE == sizeof(void *), "QT_POINTER_SIZE defined in
/*!
\fn QFlag::QFlag(ushort value)
\since Qt 5.3
\since 5.3
Constructs a QFlag object that stores the given \a value.
*/
@ -158,7 +158,7 @@ Q_STATIC_ASSERT_X(QT_POINTER_SIZE == sizeof(void *), "QT_POINTER_SIZE defined in
/*!
\fn QFlag::operator uint() const
\since Qt 5.3
\since 5.3
Returns the value stored by the QFlag object.
*/

View File

@ -10107,7 +10107,7 @@ bool QStringRef::endsWith(const QStringRef &str, Qt::CaseSensitivity cs) const
*/
/*! \fn bool QStringRef::contains(QLatin1String str, Qt::CaseSensitivity cs) const
\since 4,8
\since 4.8
\overload contains()
Returns \c true if this string reference contains an occurrence of

View File

@ -716,7 +716,7 @@ int QtPrivate::QStringList_lastIndexOf(const QStringList *that, const QRegularEx
/*!
\fn int QStringList::removeDuplicates()
\since 4.5
\since 4.5
This function removes duplicate entries from a list.
The entries do not have to be sorted. They will retain their

View File

@ -761,7 +761,9 @@ bool QNativeSocketEngine::leaveMulticastGroup(const QHostAddress &groupAddress,
return d->nativeLeaveMulticastGroup(groupAddress, iface);
}
/*! \since 4.8 */
/*!
\since 4.8
*/
QNetworkInterface QNativeSocketEngine::multicastInterface() const
{
Q_D(const QNativeSocketEngine);
@ -770,7 +772,9 @@ QNetworkInterface QNativeSocketEngine::multicastInterface() const
return d->nativeMulticastInterface();
}
/*! \since 4.8 */
/*!
\since 4.8
*/
bool QNativeSocketEngine::setMulticastInterface(const QNetworkInterface &iface)
{
Q_D(QNativeSocketEngine);

View File

@ -6596,7 +6596,7 @@ QGraphicsItem *QGraphicsItem::commonAncestorItem(const QGraphicsItem *other) con
}
/*!
\since 4,4
\since 4.4
Returns \c true if this item is currently under the mouse cursor in one of
the views; otherwise, false is returned.

View File

@ -676,7 +676,7 @@ void QMainWindow::setCentralWidget(QWidget *widget)
The ownership of the removed widget is passed to the caller.
\since Qt 5.2
\since 5.2
*/
QWidget *QMainWindow::takeCentralWidget()
{

View File

@ -1448,7 +1448,7 @@ static QString computeElidedText(Qt::TextElideMode mode, const QString &text)
/*!
Returns the minimum tab size hint for the tab at position \a index.
\since Qt 5.0
\since 5.0
*/
QSize QTabBar::minimumTabSizeHint(int index) const