From e2a77de72615d8367caa0ff7123975b4321bde0e Mon Sep 17 00:00:00 2001 From: Richard Moore Date: Sun, 6 May 2012 14:28:31 +0100 Subject: Various minor fixes for qdoc warnings. Change-Id: I54c5ab6e1bfb1816bb510be9e2bfa1e3362faa36 Reviewed-by: Casper van Donderen --- src/network/access/qftp.cpp | 50 ++++++++++++++++---------------- src/network/kernel/qdnslookup.cpp | 3 +- src/network/socket/qlocalsocket_unix.cpp | 2 +- src/network/ssl/qsslcertificate.cpp | 16 +++++----- src/network/ssl/qsslsocket.cpp | 4 +-- 5 files changed, 38 insertions(+), 37 deletions(-) (limited to 'src/network') diff --git a/src/network/access/qftp.cpp b/src/network/access/qftp.cpp index d1d1c78299..ba30ad08ba 100644 --- a/src/network/access/qftp.cpp +++ b/src/network/access/qftp.cpp @@ -1468,7 +1468,7 @@ QFtp::QFtp(QObject *parent) closed. (The state will be \c Unconnected when the connection is closed.) - \sa stateChanged() state() + \sa stateChanged(), state() */ /*! \internal @@ -1559,7 +1559,7 @@ QFtp::QFtp(QObject *parent) command, but it can also be emitted "spontaneously", e.g. when the server closes the connection unexpectedly. - \sa connectToHost() close() state() State + \sa connectToHost(), close(), state(), State */ /*! @@ -1579,7 +1579,7 @@ QFtp::QFtp(QObject *parent) This signal is emitted when processing the command identified by \a id starts. - \sa commandFinished() done() + \sa commandFinished(), done() */ /*! @@ -1590,7 +1590,7 @@ QFtp::QFtp(QObject *parent) \a id has finished. \a error is true if an error occurred during the processing; otherwise \a error is false. - \sa commandStarted() done() error() errorString() + \sa commandStarted(), done(), error(), errorString() */ /*! @@ -1602,7 +1602,7 @@ QFtp::QFtp(QObject *parent) \a error is true if an error occurred during the processing; otherwise \a error is false. - \sa commandFinished() error() errorString() + \sa commandFinished(), error(), errorString() */ /*! @@ -1623,7 +1623,7 @@ QFtp::QFtp(QObject *parent) complete data, just connect to the commandFinished() signal and read the data then instead. - \sa get() read() readAll() bytesAvailable() + \sa get(), read(), readAll(), bytesAvailable() */ /*! @@ -1675,7 +1675,7 @@ QFtp::QFtp(QObject *parent) emitted. When it is finished the commandFinished() signal is emitted. - \sa stateChanged() commandStarted() commandFinished() + \sa stateChanged(), commandStarted(), commandFinished() */ int QFtp::connectToHost(const QString &host, quint16 port) { @@ -1704,7 +1704,7 @@ int QFtp::connectToHost(const QString &host, quint16 port) emitted. When it is finished the commandFinished() signal is emitted. - \sa commandStarted() commandFinished() + \sa commandStarted(), commandFinished() */ int QFtp::login(const QString &user, const QString &password) { @@ -1731,7 +1731,7 @@ int QFtp::login(const QString &user, const QString &password) emitted. When it is finished the commandFinished() signal is emitted. - \sa stateChanged() commandStarted() commandFinished() + \sa stateChanged(), commandStarted(), commandFinished() */ int QFtp::close() { @@ -1783,7 +1783,7 @@ int QFtp::setProxy(const QString &host, quint16 port) emitted. When it is finished the commandFinished() signal is emitted. - \sa listInfo() commandStarted() commandFinished() + \sa listInfo(), commandStarted(), commandFinished() */ int QFtp::list(const QString &dir) { @@ -1810,7 +1810,7 @@ int QFtp::list(const QString &dir) emitted. When it is finished the commandFinished() signal is emitted. - \sa commandStarted() commandFinished() + \sa commandStarted(), commandFinished() */ int QFtp::cd(const QString &dir) { @@ -1855,7 +1855,7 @@ int QFtp::cd(const QString &dir) emitted. When it is finished the commandFinished() signal is emitted. - \sa readyRead() dataTransferProgress() commandStarted() + \sa readyRead(), dataTransferProgress(), commandStarted(), commandFinished() */ int QFtp::get(const QString &file, QIODevice *dev, TransferType type) @@ -1894,7 +1894,7 @@ int QFtp::get(const QString &file, QIODevice *dev, TransferType type) Since this function takes a copy of the \a data, you can discard your own copy when this function returns. - \sa dataTransferProgress() commandStarted() commandFinished() + \sa dataTransferProgress(), commandStarted(), commandFinished() */ int QFtp::put(const QByteArray &data, const QString &file, TransferType type) { @@ -1951,7 +1951,7 @@ int QFtp::put(QIODevice *dev, const QString &file, TransferType type) emitted. When it is finished the commandFinished() signal is emitted. - \sa commandStarted() commandFinished() + \sa commandStarted(), commandFinished() */ int QFtp::remove(const QString &file) { @@ -1971,7 +1971,7 @@ int QFtp::remove(const QString &file) emitted. When it is finished the commandFinished() signal is emitted. - \sa commandStarted() commandFinished() + \sa commandStarted(), commandFinished() */ int QFtp::mkdir(const QString &dir) { @@ -1991,7 +1991,7 @@ int QFtp::mkdir(const QString &dir) emitted. When it is finished the commandFinished() signal is emitted. - \sa commandStarted() commandFinished() + \sa commandStarted(), commandFinished() */ int QFtp::rmdir(const QString &dir) { @@ -2011,7 +2011,7 @@ int QFtp::rmdir(const QString &dir) emitted. When it is finished the commandFinished() signal is emitted. - \sa commandStarted() commandFinished() + \sa commandStarted(), commandFinished() */ int QFtp::rename(const QString &oldname, const QString &newname) { @@ -2038,7 +2038,7 @@ int QFtp::rename(const QString &oldname, const QString &newname) emitted. When it is finished the commandFinished() signal is emitted. - \sa rawCommandReply() commandStarted() commandFinished() + \sa rawCommandReply(), commandStarted(), commandFinished() */ int QFtp::rawCommand(const QString &command) { @@ -2051,7 +2051,7 @@ int QFtp::rawCommand(const QString &command) Returns the number of bytes that can be read from the data socket at the moment. - \sa get() readyRead() read() readAll() + \sa get(), readyRead(), read(), readAll() */ qint64 QFtp::bytesAvailable() const { @@ -2063,7 +2063,7 @@ qint64 QFtp::bytesAvailable() const Reads \a maxlen bytes from the data socket into \a data and returns the number of bytes read. Returns -1 if an error occurred. - \sa get() readyRead() bytesAvailable() readAll() + \sa get(), readyRead(), bytesAvailable(), readAll() */ qint64 QFtp::read(char *data, qint64 maxlen) { @@ -2075,7 +2075,7 @@ qint64 QFtp::read(char *data, qint64 maxlen) Reads all the bytes available from the data socket and returns them. - \sa get() readyRead() bytesAvailable() read() + \sa get(), readyRead(), bytesAvailable(), read() */ QByteArray QFtp::readAll() { @@ -2158,7 +2158,7 @@ QFtp::Command QFtp::currentCommand() const This function can be used to delete the QIODevice in the slot connected to the commandFinished() signal. - \sa get() put() + \sa get(), put() */ QIODevice* QFtp::currentDevice() const { @@ -2178,7 +2178,7 @@ QIODevice* QFtp::currentDevice() const The command that is being executed is \e not considered as a scheduled command. - \sa clearPendingCommands() currentId() currentCommand() + \sa clearPendingCommands(), currentId(), currentCommand() */ bool QFtp::hasPendingCommands() const { @@ -2191,7 +2191,7 @@ bool QFtp::hasPendingCommands() const This does not affect the command that is being executed. If you want to stop this as well, use abort(). - \sa hasPendingCommands() abort() + \sa hasPendingCommands(), abort() */ void QFtp::clearPendingCommands() { @@ -2205,7 +2205,7 @@ void QFtp::clearPendingCommands() Returns the current state of the object. When the state changes, the stateChanged() signal is emitted. - \sa State stateChanged() + \sa State, stateChanged() */ QFtp::State QFtp::state() const { diff --git a/src/network/kernel/qdnslookup.cpp b/src/network/kernel/qdnslookup.cpp index a47a26f3b7..7a1d4e45de 100644 --- a/src/network/kernel/qdnslookup.cpp +++ b/src/network/kernel/qdnslookup.cpp @@ -311,8 +311,7 @@ QString QDnsLookup::errorString() const } /*! - \property QDnsLookup::finished - \brief whether the reply has finished or was aborted. + Returns whether the reply has finished or was aborted. */ bool QDnsLookup::isFinished() const diff --git a/src/network/socket/qlocalsocket_unix.cpp b/src/network/socket/qlocalsocket_unix.cpp index 83bf441e3d..7b728be38d 100644 --- a/src/network/socket/qlocalsocket_unix.cpp +++ b/src/network/socket/qlocalsocket_unix.cpp @@ -268,7 +268,7 @@ void QLocalSocket::connectToServer(const QString &name, OpenMode openMode) Tries to connect connectingName and connectingOpenMode - \sa connectToServer() waitForConnected() + \sa connectToServer(), waitForConnected() */ void QLocalSocketPrivate::_q_connectToSocket() { diff --git a/src/network/ssl/qsslcertificate.cpp b/src/network/ssl/qsslcertificate.cpp index 95b8a8e8fa..1fc84cbec1 100644 --- a/src/network/ssl/qsslcertificate.cpp +++ b/src/network/ssl/qsslcertificate.cpp @@ -447,10 +447,10 @@ QList QSslCertificate::issuerInfoAttributes() const #if QT_DEPRECATED_SINCE(5,0) /*! - \fn QMultiMap alternateSubjectNames() const + \fn QMultiMap QSslCertificate::alternateSubjectNames() const \obsolete - Use subjectAlternativeNames(); + Use QSslCertificate::subjectAlternativeNames(); */ #endif @@ -920,11 +920,13 @@ QList 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 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, + Verifies a certificate chain. The chain to be verified is passed in the + \a certificateChain parameter. The first certificate in the list should + be the leaf certificate of the chain to be verified. 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 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. diff --git a/src/network/ssl/qsslsocket.cpp b/src/network/ssl/qsslsocket.cpp index 6f031f241c..a041a2aaf1 100644 --- a/src/network/ssl/qsslsocket.cpp +++ b/src/network/ssl/qsslsocket.cpp @@ -757,7 +757,7 @@ qint64 QSslSocket::encryptedBytesToWrite() const \reimp Returns true if you can read one while line (terminated by a single ASCII - '\n' character) of decrypted characters; otherwise, false is returned. + '\\n' character) of decrypted characters; otherwise, false is returned. */ bool QSslSocket::canReadLine() const { @@ -1673,7 +1673,7 @@ void QSslSocket::startClientEncryption() initiate the SSL handshake. Most servers will call this function immediately upon receiving a connection, or as a result of having received a protocol-specific command to enter SSL mode (e.g, the - server may respond to receiving the string "STARTTLS\r\n" by + server may respond to receiving the string "STARTTLS\\r\\n" by calling this function). The most common way to implement an SSL server is to create a -- cgit v1.2.3