QSslCertificate: extend documentation for new verify method

Change-Id: I47e038299a7e6ef18206839ff59ecef9f0860415
Reviewed-on: http://codereview.qt.nokia.com/1510
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Markus Goetz

diff --git a/src/network/ssl/qsslcertificate.cpp b/src/network/ssl/qsslcertificate.cpp
index 41e54b2..94273b0 100644 (file)
--- a/src/network/ssl/qsslcertificate.cpp
+++ b/src/network/ssl/qsslcertificate.cpp
@@ -668,10 +668,14 @@ QList<QSslCertificate> QSslCertificate::fromData(const QByteArray &data, QSsl::E
 }
 
 /*!
-    Verifies a certificate chain. If a hostName is specified then the certificate is
-    also checked to see if it is valid for the specified hostName.
+    Verifies a certificate chain. If \a hostName is specified then the certificate is
+    also checked to see if it is valid for the specified host name.
     Note that the first certificate in the list should be the leaf certificate of
     the chain to be verified.
+    The root (CA) certificate should not be included in the list to be verified,
+    this will be looked up automatically either using the CA list specified by
+    QSslSocket::defaultCaCertificates() or, if possible, it will be loaded on demand
+    on Unix.
  */
 QList<QSslError> QSslCertificate::verify(QList<QSslCertificate> certificateChain, const QString &hostName)
 {