From 6f09e100c98e5636eff14c99a973817b5b17f492 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Thu, 16 Aug 2012 10:02:59 +0200 Subject: doc: Fixed qdoc errors in SSL 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 --- src/network/ssl/qssl.cpp | 16 ++++++++-------- src/network/ssl/qsslconfiguration.cpp | 10 ++++++---- 2 files changed, 14 insertions(+), 12 deletions(-) (limited to 'src') diff --git a/src/network/ssl/qssl.cpp b/src/network/ssl/qssl.cpp index 60679a201f..932b7c9f99 100644 --- a/src/network/ssl/qssl.cpp +++ b/src/network/ssl/qssl.cpp @@ -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 diff --git a/src/network/ssl/qsslconfiguration.cpp b/src/network/ssl/qsslconfiguration.cpp index 3dedd29bfe..96337372e0 100644 --- a/src/network/ssl/qsslconfiguration.cpp +++ b/src/network/ssl/qsslconfiguration.cpp @@ -520,9 +520,11 @@ void QSslConfiguration::setCaCertificates(const QList &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 { -- cgit v1.2.3