diff options
| author | Martin Smith <martin.smith@nokia.com> | 2012-08-16 10:02:59 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-18 21:08:33 +0200 |
| commit | 6f09e100c98e5636eff14c99a973817b5b17f492 (patch) | |
| tree | 9d3a1b9e13e77a9b0569267221a6613c717fcfb5 /src/network | |
| parent | 8f7a135a105fe093da153d4fa466377b8bcfac57 (diff) | |
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 <rich@kde.org>
Diffstat (limited to 'src/network')
| -rw-r--r-- | src/network/ssl/qssl.cpp | 16 | ||||
| -rw-r--r-- | src/network/ssl/qsslconfiguration.cpp | 10 |
2 files changed, 14 insertions, 12 deletions
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<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 { |