1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some qdoc warnings for 5.9

Browse Source 
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>
This commit is contained in:
Friedemann Kleint 2017-02-03 15:09:32 +01:00
parent 91120599ae
commit 4bf0ddb3f1
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/corelib/tools/qbytearraymatcher.cpp
View File

@ -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 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 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 Searches the char string \a haystack, from byte position \a from
(default 0, i.e. from the first byte), for the byte array pattern() (default 0, i.e. from the first byte), for the byte array pattern()

8
src/network/access/qhstspolicy.cpp
View File

@ -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() \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) 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. while agreeing on whether to include or exclude subdomains.
*/ */
bool QHstsPolicy::operator==(const QHstsPolicy &other) const bool QHstsPolicy::operator==(const QHstsPolicy &other) const

2
src/widgets/kernel/qsizepolicy.cpp
View File

@ -400,7 +400,7 @@ void QSizePolicy::setControlType(ControlType type)
*/ */
/*! /*!
\fn QSizePolicy QSizePolicy::transposed() \fn QSizePolicy QSizePolicy::transposed() const
\since 5.9 \since 5.9
Returns a size policy object with the horizontal and vertical Returns a size policy object with the horizontal and vertical

2
src/widgets/util/qundostack.cpp
View File

@ -164,7 +164,7 @@ bool QUndoCommand::isObsolete() const
/*! /*!
\since 5.9 \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() \sa isObsolete(), mergeWith(), QUndoStack::push(), QUndoStack::undo(), QUndoStack::redo()
*/ */