AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Add more missing return types to \fn commands

Browse Source 
Added missing return types to \fn commands and removed
some unnecessary \internal comments.

Change-Id: Ie6691f83a1c510134d1e83c3d98758360a67217e
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Martin Smith 2018-01-18 13:42:07 +01:00
parent f53cbd2688
commit f30d733d1c
5 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/network/kernel/qhostaddress.cpp
View File

@ -1233,7 +1233,7 @@ bool QHostAddress::isGlobal() const
\l{https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml}{IANA \l{https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml}{IANA
IPv6 Address Space} registry for more information. IPv6 Address Space} registry for more information.
\sa isLoopback(), isGlobal(). isMulticast(), isSiteLocal(), isUniqueLocalUnicast() \sa isLoopback(), isGlobal(), isMulticast(), isSiteLocal(), isUniqueLocalUnicast()
*/ */
bool QHostAddress::isLinkLocal() const bool QHostAddress::isLinkLocal() const
{ {
@ -1338,8 +1338,8 @@ uint qHash(const QHostAddress &key, uint seed) Q_DECL_NOTHROW
} }
/*! /*!
\fn bool operator==(QHostAddress::SpecialAddress lhs, const QHostAddress &rhs)
\relates QHostAddress \relates QHostAddress
\fn operator==(QHostAddress::SpecialAddress lhs, const QHostAddress &rhs)
Returns \c true if special address \a lhs is the same as host address \a rhs; Returns \c true if special address \a lhs is the same as host address \a rhs;
otherwise returns \c false. otherwise returns \c false.
@ -1348,9 +1348,9 @@ uint qHash(const QHostAddress &key, uint seed) Q_DECL_NOTHROW
*/ */
/*! /*!
\fn bool operator!=(QHostAddress::SpecialAddress lhs, const QHostAddress &rhs)
\relates QHostAddress \relates QHostAddress
\since 5.9 \since 5.9
\fn operator!=(QHostAddress::SpecialAddress lhs, const QHostAddress &rhs)
Returns \c false if special address \a lhs is the same as host address \a rhs; Returns \c false if special address \a lhs is the same as host address \a rhs;
otherwise returns \c true. otherwise returns \c true.

2
src/network/kernel/qnetworkinterface.cpp
View File

@ -166,7 +166,7 @@ QString QNetworkInterfacePrivate::makeHwAddress(int len, uchar *data)
*/ */
/*! /*!
\enum QNetworkAddressEntry::DnsEligilibilityStatus \enum QNetworkAddressEntry::DnsEligibilityStatus
\since 5.11 \since 5.11
This enum indicates whether a given host address is eligible to be This enum indicates whether a given host address is eligible to be

6
src/network/ssl/qsslsocket.cpp
View File

@ -215,7 +215,7 @@
*/ */
/*! /*!
\fn QSslSocket::encrypted() \fn void QSslSocket::encrypted()
This signal is emitted when QSslSocket enters encrypted mode. After this This signal is emitted when QSslSocket enters encrypted mode. After this
signal has been emitted, QSslSocket::isEncrypted() will return true, and signal has been emitted, QSslSocket::isEncrypted() will return true, and
@ -225,7 +225,7 @@
*/ */
/*! /*!
\fn QSslSocket::modeChanged(QSslSocket::SslMode mode) \fn void QSslSocket::modeChanged(QSslSocket::SslMode mode)
This signal is emitted when QSslSocket changes from \l This signal is emitted when QSslSocket changes from \l
QSslSocket::UnencryptedMode to either \l QSslSocket::SslClientMode or \l QSslSocket::UnencryptedMode to either \l QSslSocket::SslClientMode or \l
@ -235,7 +235,7 @@
*/ */
/*! /*!
\fn QSslSocket::encryptedBytesWritten(qint64 written) \fn void QSslSocket::encryptedBytesWritten(qint64 written)
\since 4.4 \since 4.4
This signal is emitted when QSslSocket writes its encrypted data to the This signal is emitted when QSslSocket writes its encrypted data to the

3
src/network/ssl/qsslsocket_openssl11.cpp
View File

@ -73,9 +73,6 @@ QT_BEGIN_NAMESPACE
Q_GLOBAL_STATIC_WITH_ARGS(QMutex, qt_opensslInitMutex, (QMutex::Recursive)) Q_GLOBAL_STATIC_WITH_ARGS(QMutex, qt_opensslInitMutex, (QMutex::Recursive))
/*!
\internal
*/
void QSslSocketPrivate::deinitialize() void QSslSocketPrivate::deinitialize()
{ {
// This function exists only for compatibility with the pre-11 code, // This function exists only for compatibility with the pre-11 code,

3
src/network/ssl/qsslsocket_opensslpre11.cpp
View File

@ -198,9 +198,6 @@ static void q_OpenSSL_add_all_algorithms_safe()
} }
/*!
\internal
*/
void QSslSocketPrivate::deinitialize() void QSslSocketPrivate::deinitialize()
{ {
q_CRYPTO_set_id_callback(0); q_CRYPTO_set_id_callback(0);