doc: Add \since 6.0 to future functions

qdoc needs to know that a qdoc comment should not be part of the
documentation until a future version. In this case, some new functions
were declared to become active in Qt 6.0, but qdoc had no way of
detecting this and reported errors about them incorrectly. Adding
\since 6.0 to the qdoc comments for these functions allows qdoc to
ignore them without printing the errors.

It is also not allowed to document static functions declared in .cpp
files, because these functions are not in the public API. The qdoc
comment marker was removed from the comments for a few such static
functions.

Change-Id: I55ce0e8fb823b1dcf498d5a2436ddb20ad0a7527
Reviewed-by: Martin Smith <martin.smith@qt.io>
bb10
Martin Smith 2018-10-19 17:10:41 +02:00
parent 1864748136
commit 7087a68fbf
3 changed files with 4 additions and 2 deletions

View File

@ -316,6 +316,7 @@ bool QAbstractProxyModel::setHeaderData(int section, Qt::Orientation orientation
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
/*!
\reimp
\since 6.0
*/
bool QAbstractProxyModel::clearItemData(const QModelIndex &index)
{

View File

@ -230,6 +230,7 @@ bool QStringListModel::setData(const QModelIndex &index, const QVariant &value,
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
/*!
\reimp
\since 6.0
*/
bool QStringListModel::clearItemData(const QModelIndex &index)
{

View File

@ -3076,7 +3076,7 @@ bool QByteArray::endsWith(const char *str) const
return qstrncmp(d->data() + d->size - len, str, len) == 0;
}
/*!
/*
Returns true if \a c is an uppercase Latin1 letter.
\note The multiplication sign 0xD7 and the sz ligature 0xDF are not
treated as uppercase Latin1.
@ -3112,7 +3112,7 @@ bool QByteArray::isUpper() const
return true;
}
/*!
/*
Returns true if \a c is an lowercase Latin1 letter.
\note The division sign 0xF7 is not treated as lowercase Latin1,
but the small y dieresis 0xFF is.