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

doc: Fixed qdoc errors in SSL

Browse Source 
Fixed some bad camel case, marked some parameters with \a,
and changed a \enum to a \typedef. Removed some obasolete
text.

Change-Id: I1e69dd9f3b74129230770addc80fe1c125faf268
Reviewed-by: Richard J. Moore <rich@kde.org>
This commit is contained in:
Martin Smith 2012-08-16 10:02:59 +02:00 committed by Qt by Nokia
parent 8f7a135a10
commit 6f09e100c9
2 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/network/ssl/qssl.cpp
View File

@ -96,18 +96,18 @@ QT_BEGIN_NAMESPACE
\value DnsEntry A DNS host name entry; the entry contains a host name
entry that the certificate is valid for. The entry may contain wildcards.
\sa QSslCertificate::subjectAlternativeNames()
\note In Qt 4, this enum was called \c {AlternateNameEntryType}. That name
is deprecated in Qt 5.
\sa QSslCertificate::subjectAlternativeNames()
*/
#if QT_DEPRECATED_SINCE(5,0)
/*!
\enum QSsl::AlternateNameEntryType
\obsolete
Use QSsl::AlternativeNameEntryType instead.
This is a synonym for source compatibility with Qt 4.
\sa QSsl::AlternativeNameEntryType
\typedef QSsl::AlternateNameEntryType
\obsolete
Use QSsl::AlternativeNameEntryType instead.
*/
#endif
/*!
\enum QSsl::SslProtocol

10
src/network/ssl/qsslconfiguration.cpp
View File

@ -520,9 +520,11 @@ void QSslConfiguration::setCaCertificates(const QList<QSslCertificate> &certific
}
/*!
Enables or disables an SSL compatibility option.
Enables or disables an SSL compatibility \a option. If \a on
is true, the \a option is enabled. If \a on is false, the
\a option is disabled.
\sa testSSlOption()
\sa testSslOption()
*/
void QSslConfiguration::setSslOption(QSsl::SslOption option, bool on)
{
@ -535,9 +537,9 @@ void QSslConfiguration::setSslOption(QSsl::SslOption option, bool on)
/*!
\since 4.8
Returns true if the specified SSL compatibility option is enabled.
Returns true if the specified SSL compatibility \a option is enabled.
\sa testSSlOption()
\sa setSslOption()
*/
bool QSslConfiguration::testSslOption(QSsl::SslOption option) const
{