Replace Note: with \note in documentation

Change-Id: I213ac1fb2733e675f3641441fe6c621bab06c1f0
Reviewed-by: Peter Hartmann <phartmann@blackberry.com>
Reviewed-by: Richard J. Moore <rich@kde.org>
This commit is contained in:
Kurt Pattyn 2014-03-09 14:39:20 +01:00 committed by The Qt Project
parent 9f87c3663d
commit 1f4cda9a70
13 changed files with 18 additions and 19 deletions

View File

@ -169,7 +169,7 @@ void QHttpPart::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &
QNetworkRequest::KnownHeaders), the raw format will be parsed and
the corresponding "cooked" header will be set as well.
Note: setting the same header twice overrides the previous
\note Setting the same header twice overrides the previous
setting. To accomplish the behaviour of multiple HTTP headers of
the same name, you should concatenate the two values, separating
them with a comma (",") and set one single raw header.

View File

@ -518,7 +518,7 @@ void QNetworkDiskCache::setMaximumCacheSize(qint64 size)
knows about that QNetworkDiskCache does not, for example the number of times
a cache is accessed.
Note: cacheSize() calls expire if the current cache size is unknown.
\note cacheSize() calls expire if the current cache size is unknown.
\sa maximumCacheSize(), fileMetaData()
*/

View File

@ -753,7 +753,7 @@ qint64 QNetworkReply::writeData(const char *, qint64)
Sets the associated operation for this object to be \a
operation. This value will be returned by operation().
Note: the operation should be set when this object is created and
\note The operation should be set when this object is created and
not changed again.
\sa operation(), setRequest()
@ -768,7 +768,7 @@ void QNetworkReply::setOperation(QNetworkAccessManager::Operation operation)
Sets the associated request for this object to be \a request. This
value will be returned by request().
Note: the request should be set when this object is created and
\note The request should be set when this object is created and
not changed again.
\sa request(), setOperation()

View File

@ -512,7 +512,7 @@ QList<QByteArray> QNetworkRequest::rawHeaderList() const
will also set the known header LastModifiedHeader to be the
QDateTime object of the parsed date.
Note: setting the same header twice overrides the previous
\note Setting the same header twice overrides the previous
setting. To accomplish the behaviour of multiple HTTP headers of
the same name, you should concatenate the two values, separating
them with a comma (",") and set one single raw header.
@ -528,7 +528,7 @@ void QNetworkRequest::setRawHeader(const QByteArray &headerName, const QByteArra
Returns the attribute associated with the code \a code. If the
attribute has not been set, it returns \a defaultValue.
Note: this function does not apply the defaults listed in
\note This function does not apply the defaults listed in
QNetworkRequest::Attribute.
\sa setAttribute(), QNetworkRequest::Attribute

View File

@ -433,7 +433,7 @@ void QHostInfo::setErrorString(const QString &str)
Returns the DNS domain of this machine.
Note: DNS domains are not related to domain names found in
\note DNS domains are not related to domain names found in
Windows networks.
\sa hostName()

View File

@ -841,7 +841,7 @@ QList<QByteArray> QNetworkProxy::rawHeaderList() const
will also set the known header LastModifiedHeader to be the
QDateTime object of the parsed date.
Note: setting the same header twice overrides the previous
\note Setting the same header twice overrides the previous
setting. To accomplish the behaviour of multiple HTTP headers of
the same name, you should concatenate the two values, separating
them with a comma (",") and set one single raw header.

View File

@ -1552,7 +1552,7 @@ bool QAbstractSocket::bind(quint16 port, BindMode mode)
Returns \c true if the socket is valid and ready for use; otherwise
returns \c false.
\b{Note:} The socket's state must be ConnectedState before reading and
\note The socket's state must be ConnectedState before reading and
writing can occur.
\sa state()

View File

@ -278,8 +278,7 @@ bool QLocalServer::isListening() const
could also be a path such as "/tmp/foo" and on Windows this could
be a pipe path such as "\\\\.\\pipe\\foo"
Note:
On Unix if the server crashes without closing listen will fail
\note On Unix if the server crashes without closing listen will fail
with AddressInUseError. To create a new server the file should be removed.
On Windows two local servers can listen to the same pipe at the same
time, but any connections will go to one of the server.

View File

@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE
waitForReadyRead(), waitForBytesWritten(), and waitForDisconnected()
which blocks until the operation is complete or the timeout expires.
Note that this feature is not supported on versions of Windows earlier than
\note This feature is not supported on versions of Windows earlier than
Windows XP.
\sa QLocalServer

View File

@ -58,7 +58,7 @@
allows you to establish a TCP connection and transfer streams of
data. See the QAbstractSocket documentation for details.
\b{Note:} TCP sockets cannot be opened in QIODevice::Unbuffered mode.
\note TCP sockets cannot be opened in QIODevice::Unbuffered mode.
\sa QTcpServer, QUdpSocket, QNetworkAccessManager,
{Fortune Server Example}, {Fortune Client Example},

View File

@ -129,7 +129,7 @@ QT_BEGIN_NAMESPACE
\value SecureProtocols The default option, using protocols known to be secure;
currently behaves like TlsV1SslV3.
Note: most servers using SSL understand both versions (2 and 3),
\note most servers using SSL understand both versions (2 and 3),
but it is recommended to use the latest version only for security
reasons. However, SSL and TLS are not compatible with each other:
if you get unexpected handshake failures, verify that you chose
@ -176,7 +176,7 @@ QT_BEGIN_NAMESPACE
SslOptionDisableSessionPersistence is turned on to optimize memory usage.
The other options are turned off.
Note: Availability of above options depends on the version of the SSL
\note Availability of above options depends on the version of the SSL
backend in use.
*/

View File

@ -644,7 +644,7 @@ bool QSslConfiguration::testSslOption(QSsl::SslOption option) const
used or QSsl::SslOptionDisableSessionPersistence was not turned off,
this function returns an empty QByteArray.
\b{Note:} When persisting the session ticket to disk or similar, be
\note When persisting the session ticket to disk or similar, be
careful not to expose the session to a potential attacker, as
knowledge of the session allows for eavesdropping on data
encrypted with the session parameters.

View File

@ -283,7 +283,7 @@
\a errors contains one or more errors that prevent QSslSocket from
verifying the identity of the peer.
Note: You cannot use Qt::QueuedConnection when connecting to this signal,
\note You cannot use Qt::QueuedConnection when connecting to this signal,
or calling QSslSocket::ignoreSslErrors() will have no effect.
\sa peerVerifyError()
@ -400,7 +400,7 @@ void QSslSocket::resume()
\snippet code/src_network_ssl_qsslsocket.cpp 3
\b{Note:} The example above shows that text can be written to
\note The example above shows that text can be written to
the socket immediately after requesting the encrypted connection,
before the encrypted() signal has been emitted. In such cases, the
text is queued in the object and written to the socket \e after
@ -470,7 +470,7 @@ void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port,
The socket is opened in the mode specified by \a openMode, and
enters the socket state specified by \a state.
\b{Note:} It is not possible to initialize two sockets with the same
\note It is not possible to initialize two sockets with the same
native socket descriptor.
\sa socketDescriptor()