1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Various minor fixes for qdoc warnings.

Browse Source 
Change-Id: I54c5ab6e1bfb1816bb510be9e2bfa1e3362faa36
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
This commit is contained in:
Richard Moore 2012-05-06 14:28:31 +01:00 committed by Qt by Nokia
parent eee3798f6f
commit e2a77de726
5 changed files with 38 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/network/access/qftp.cpp
View File

@ -1468,7 +1468,7 @@ QFtp::QFtp(QObject *parent)
closed. (The state will be \c Unconnected when the connection is closed. (The state will be \c Unconnected when the connection is
closed.) closed.)
\sa stateChanged() state() \sa stateChanged(), state()
*/ */
/*! /*!
\internal \internal
@ -1559,7 +1559,7 @@ QFtp::QFtp(QObject *parent)
command, but it can also be emitted "spontaneously", e.g. when the command, but it can also be emitted "spontaneously", e.g. when the
server closes the connection unexpectedly. 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 This signal is emitted when processing the command identified by
\a id starts. \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 \a id has finished. \a error is true if an error occurred during
the processing; otherwise \a error is false. 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; \a error is true if an error occurred during the processing;
otherwise \a error is false. 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 complete data, just connect to the commandFinished() signal and
read the data then instead. 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa stateChanged() commandStarted() commandFinished() \sa stateChanged(), commandStarted(), commandFinished()
*/ */
int QFtp::connectToHost(const QString &host, quint16 port) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa commandStarted() commandFinished() \sa commandStarted(), commandFinished()
*/ */
int QFtp::login(const QString &user, const QString &password) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa stateChanged() commandStarted() commandFinished() \sa stateChanged(), commandStarted(), commandFinished()
*/ */
int QFtp::close() 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa listInfo() commandStarted() commandFinished() \sa listInfo(), commandStarted(), commandFinished()
*/ */
int QFtp::list(const QString &dir) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa commandStarted() commandFinished() \sa commandStarted(), commandFinished()
*/ */
int QFtp::cd(const QString &dir) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa readyRead() dataTransferProgress() commandStarted() \sa readyRead(), dataTransferProgress(), commandStarted(),
commandFinished() commandFinished()
*/ */
int QFtp::get(const QString &file, QIODevice *dev, TransferType type) 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 Since this function takes a copy of the \a data, you can discard
your own copy when this function returns. 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) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa commandStarted() commandFinished() \sa commandStarted(), commandFinished()
*/ */
int QFtp::remove(const QString &file) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa commandStarted() commandFinished() \sa commandStarted(), commandFinished()
*/ */
int QFtp::mkdir(const QString &dir) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa commandStarted() commandFinished() \sa commandStarted(), commandFinished()
*/ */
int QFtp::rmdir(const QString &dir) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa commandStarted() commandFinished() \sa commandStarted(), commandFinished()
*/ */
int QFtp::rename(const QString &oldname, const QString &newname) 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. When it is finished the commandFinished() signal is
emitted. emitted.
\sa rawCommandReply() commandStarted() commandFinished() \sa rawCommandReply(), commandStarted(), commandFinished()
*/ */
int QFtp::rawCommand(const QString &command) 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 Returns the number of bytes that can be read from the data socket
at the moment. at the moment.
\sa get() readyRead() read() readAll() \sa get(), readyRead(), read(), readAll()
*/ */
qint64 QFtp::bytesAvailable() const qint64 QFtp::bytesAvailable() const
{ {
@ -2063,7 +2063,7 @@ qint64 QFtp::bytesAvailable() const
Reads \a maxlen bytes from the data socket into \a data and Reads \a maxlen bytes from the data socket into \a data and
returns the number of bytes read. Returns -1 if an error occurred. 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) 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 Reads all the bytes available from the data socket and returns
them. them.
\sa get() readyRead() bytesAvailable() read() \sa get(), readyRead(), bytesAvailable(), read()
*/ */
QByteArray QFtp::readAll() 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 This function can be used to delete the QIODevice in the slot connected to
the commandFinished() signal. the commandFinished() signal.
\sa get() put() \sa get(), put()
*/ */
QIODevice* QFtp::currentDevice() const QIODevice* QFtp::currentDevice() const
{ {
@ -2178,7 +2178,7 @@ QIODevice* QFtp::currentDevice() const
The command that is being executed is \e not considered as a The command that is being executed is \e not considered as a
scheduled command. scheduled command.
\sa clearPendingCommands() currentId() currentCommand() \sa clearPendingCommands(), currentId(), currentCommand()
*/ */
bool QFtp::hasPendingCommands() const bool QFtp::hasPendingCommands() const
{ {
@ -2191,7 +2191,7 @@ bool QFtp::hasPendingCommands() const
This does not affect the command that is being executed. If you This does not affect the command that is being executed. If you
want to stop this as well, use abort(). want to stop this as well, use abort().
\sa hasPendingCommands() abort() \sa hasPendingCommands(), abort()
*/ */
void QFtp::clearPendingCommands() void QFtp::clearPendingCommands()
{ {
@ -2205,7 +2205,7 @@ void QFtp::clearPendingCommands()
Returns the current state of the object. When the state changes, Returns the current state of the object. When the state changes,
the stateChanged() signal is emitted. the stateChanged() signal is emitted.
\sa State stateChanged() \sa State, stateChanged()
*/ */
QFtp::State QFtp::state() const QFtp::State QFtp::state() const
{ {

3
src/network/kernel/qdnslookup.cpp
View File

@ -311,8 +311,7 @@ QString QDnsLookup::errorString() const
} }
/*! /*!
\property QDnsLookup::finished Returns whether the reply has finished or was aborted.
\brief whether the reply has finished or was aborted.
*/ */
bool QDnsLookup::isFinished() const bool QDnsLookup::isFinished() const

2
src/network/socket/qlocalsocket_unix.cpp
View File

@ -268,7 +268,7 @@ void QLocalSocket::connectToServer(const QString &name, OpenMode openMode)
Tries to connect connectingName and connectingOpenMode Tries to connect connectingName and connectingOpenMode
\sa connectToServer() waitForConnected() \sa connectToServer(), waitForConnected()
*/ */
void QLocalSocketPrivate::_q_connectToSocket() void QLocalSocketPrivate::_q_connectToSocket()
{ {

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

@ -447,10 +447,10 @@ QList<QByteArray> QSslCertificate::issuerInfoAttributes() const
#if QT_DEPRECATED_SINCE(5,0) #if QT_DEPRECATED_SINCE(5,0)
/*! /*!
\fn QMultiMap<QSsl::AlternateNameEntryType, QString> alternateSubjectNames() const \fn QMultiMap<QSsl::AlternateNameEntryType, QString> QSslCertificate::alternateSubjectNames() const
\obsolete \obsolete
Use subjectAlternativeNames(); Use QSslCertificate::subjectAlternativeNames();
*/ */
#endif #endif
@ -920,11 +920,13 @@ QList<QSslCertificate> QSslCertificate::fromData(const QByteArray &data, QSsl::E
} }
/*! /*!
Verifies a certificate chain. If \a hostName is specified then the certificate is Verifies a certificate chain. The chain to be verified is passed in the
also checked to see if it is valid for the specified host name. \a certificateChain parameter. The first certificate in the list should
Note that the first certificate in the list should be the leaf certificate of be the leaf certificate of the chain to be verified. If \a hostName is
the chain to be verified. specified then the certificate is also checked to see if it is valid for
The root (CA) certificate should not be included in the list to be verified, 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 this will be looked up automatically either using the CA list specified by
QSslSocket::defaultCaCertificates() or, if possible, it will be loaded on demand QSslSocket::defaultCaCertificates() or, if possible, it will be loaded on demand
on Unix. on Unix.

4
src/network/ssl/qsslsocket.cpp
View File

@ -757,7 +757,7 @@ qint64 QSslSocket::encryptedBytesToWrite() const
\reimp \reimp
Returns true if you can read one while line (terminated by a single ASCII 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 bool QSslSocket::canReadLine() const
{ {
@ -1673,7 +1673,7 @@ void QSslSocket::startClientEncryption()
initiate the SSL handshake. Most servers will call this function initiate the SSL handshake. Most servers will call this function
immediately upon receiving a connection, or as a result of having immediately upon receiving a connection, or as a result of having
received a protocol-specific command to enter SSL mode (e.g, the 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). calling this function).
The most common way to implement an SSL server is to create a The most common way to implement an SSL server is to create a