diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2017-02-03 15:09:32 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2017-02-06 16:58:04 +0000 |
| commit | 4bf0ddb3f1e07ddb88cbffa2973be6b77c31fd1d (patch) | |
| tree | eddc6c06fc118fb2c2164b6a3fbf74e89d3b6ffa | |
| parent | 91120599aee881bd1021087bae91fd1d5de46a4c (diff) | |
Fix some qdoc warnings for 5.9
Fix warnings:
src/network/access/qhstspolicy.cpp:158: warning: Undocumented parameter 'expiry' in QHstsPolicy::setExpiry()
src/network/access/qhstspolicy.cpp:178: warning: Undocumented parameter 'include' in QHstsPolicy::setIncludesSubDomains()
src/network/access/qhstspolicy.cpp:178: warning: Can't link to 'includeSubdomains()'
src/widgets/kernel/qsizepolicy.cpp:402: warning: Cannot find 'transposed(...)' in '\fn' QSizePolicy QSizePolicy::transposed()
src/widgets/kernel/qsizepolicy.h:165: warning: No documentation for 'QSizePolicy::transposed()'
src/widgets/util/qundostack.cpp:164: warning: Undocumented parameter 'obsolete' in QUndoCommand::setObsolete()
Fix the signature of the QStaticByteArrayMatcher member functions. The warnings
src/corelib/tools/qbytearraymatcher.cpp:372: warning: Cannot find 'indexIn(...)' in '\fn' QStaticByteArrayMatcher::indexIn(const char *haystack, int hlen, int from)
src/corelib/tools/qbytearraymatcher.cpp:382: warning: Cannot find 'indexIn(...)' in '\fn' QStaticByteArrayMatcher::indexIn(const QByteArray &haystack, int from)
remain, though since apparently qdoc is thrown off by the constructor.
Change-Id: I157359a881ff3fbc80d2eeb52dd5c27249d009c4
Reviewed-by: Jesus Fernandez <Jesus.Fernandez@qt.io>
Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
| -rw-r--r-- | src/corelib/tools/qbytearraymatcher.cpp | 4 | ||||
| -rw-r--r-- | src/network/access/qhstspolicy.cpp | 8 | ||||
| -rw-r--r-- | src/widgets/kernel/qsizepolicy.cpp | 2 | ||||
| -rw-r--r-- | src/widgets/util/qundostack.cpp | 2 |
4 files changed, 8 insertions, 8 deletions
diff --git a/src/corelib/tools/qbytearraymatcher.cpp b/src/corelib/tools/qbytearraymatcher.cpp index fc9d12aba5..76af726ef9 100644 --- a/src/corelib/tools/qbytearraymatcher.cpp +++ b/src/corelib/tools/qbytearraymatcher.cpp @@ -370,7 +370,7 @@ int qFindByteArray( */ /*! - \fn QStaticByteArrayMatcher::indexIn(const char *haystack, int hlen, int from) + \fn int QStaticByteArrayMatcher::indexIn(const char *haystack, int hlen, int from = 0) const Searches the char string \a haystack, which has length \a hlen, from byte position \a from (default 0, i.e. from the first byte), for @@ -380,7 +380,7 @@ int qFindByteArray( */ /*! - \fn QStaticByteArrayMatcher::indexIn(const QByteArray &haystack, int from) + \fn int QStaticByteArrayMatcher::indexIn(const QByteArray &haystack, int from = 0) const Searches the char string \a haystack, from byte position \a from (default 0, i.e. from the first byte), for the byte array pattern() diff --git a/src/network/access/qhstspolicy.cpp b/src/network/access/qhstspolicy.cpp index 2cec587f4d..6922e1d8f9 100644 --- a/src/network/access/qhstspolicy.cpp +++ b/src/network/access/qhstspolicy.cpp @@ -156,7 +156,7 @@ QString QHstsPolicy::host(QUrl::ComponentFormattingOptions options) const } /*! - Sets the expiration date for the policy (in UTC). + Sets the expiration date for the policy (in UTC) to \a expiry. \sa expiry() */ @@ -176,9 +176,9 @@ QDateTime QHstsPolicy::expiry() const } /*! - Includes or excludes subdomains for this policy. + Sets whether subdomains are included for this policy to \a include. - \sa includeSubdomains() + \sa includesSubDomains() */ void QHstsPolicy::setIncludesSubDomains(bool include) { @@ -196,7 +196,7 @@ bool QHstsPolicy::includesSubDomains() const } /*! - Returns \c true if the two policies have the same host and expriration date + Returns \c true if the two policies have the same host and expiration date while agreeing on whether to include or exclude subdomains. */ bool QHstsPolicy::operator==(const QHstsPolicy &other) const diff --git a/src/widgets/kernel/qsizepolicy.cpp b/src/widgets/kernel/qsizepolicy.cpp index 34ad64217b..a03523d2af 100644 --- a/src/widgets/kernel/qsizepolicy.cpp +++ b/src/widgets/kernel/qsizepolicy.cpp @@ -400,7 +400,7 @@ void QSizePolicy::setControlType(ControlType type) */ /*! - \fn QSizePolicy QSizePolicy::transposed() + \fn QSizePolicy QSizePolicy::transposed() const \since 5.9 Returns a size policy object with the horizontal and vertical diff --git a/src/widgets/util/qundostack.cpp b/src/widgets/util/qundostack.cpp index 3d21320655..dc0b6855ac 100644 --- a/src/widgets/util/qundostack.cpp +++ b/src/widgets/util/qundostack.cpp @@ -164,7 +164,7 @@ bool QUndoCommand::isObsolete() const /*! \since 5.9 - Sets whether the command is obsolete. + Sets whether the command is obsolete to \a obsolete. \sa isObsolete(), mergeWith(), QUndoStack::push(), QUndoStack::undo(), QUndoStack::redo() */ |