diff options
| author | Martin Smith <martin.smith@qt.io> | 2018-10-19 17:10:41 +0200 |
|---|---|---|
| committer | Martin Smith <martin.smith@qt.io> | 2018-10-30 17:20:10 +0000 |
| commit | 7087a68fbf42799eb2d11bc072b63033ae58e8b4 (patch) | |
| tree | a2a88b90160fec15e7846cd2c23729dc67c7b9da | |
| parent | 1864748136c5ef9e6e435f201f2485bfeb7ada0f (diff) | |
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>
| -rw-r--r-- | src/corelib/itemmodels/qabstractproxymodel.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/itemmodels/qstringlistmodel.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/tools/qbytearray.cpp | 4 |
3 files changed, 4 insertions, 2 deletions
diff --git a/src/corelib/itemmodels/qabstractproxymodel.cpp b/src/corelib/itemmodels/qabstractproxymodel.cpp index 095ab6fc71..118e808a3c 100644 --- a/src/corelib/itemmodels/qabstractproxymodel.cpp +++ b/src/corelib/itemmodels/qabstractproxymodel.cpp @@ -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) { diff --git a/src/corelib/itemmodels/qstringlistmodel.cpp b/src/corelib/itemmodels/qstringlistmodel.cpp index 3cc0bee8ef..cc7a885641 100644 --- a/src/corelib/itemmodels/qstringlistmodel.cpp +++ b/src/corelib/itemmodels/qstringlistmodel.cpp @@ -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) { diff --git a/src/corelib/tools/qbytearray.cpp b/src/corelib/tools/qbytearray.cpp index 03dd1e63cd..1d8621ad5a 100644 --- a/src/corelib/tools/qbytearray.cpp +++ b/src/corelib/tools/qbytearray.cpp @@ -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. |