Changeset 561 for trunk/src/network/socket/qlocalsocket.cpp

Timestamp:

Feb 11, 2010, 11:19:06 PM (15 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.6.1 sources.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/network/socket/qlocalsocket.cpp (modified) (14 diffs)

trunk/src/network/socket/qlocalsocket.cpp

@@ -2 +2 @@
 **
 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
-** Contact: Qt Software Information (qt-info@nokia.com)
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
 **
 ** This file is part of the QtNetwork module of the Qt Toolkit.
@@ -21 +22 @@
 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 **
-** In addition, as a special exception, Nokia gives you certain
-** additional rights. These rights are described in the Nokia Qt LGPL
-** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
-** package.
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 **
 ** GNU General Public License Usage
@@ -34 +34 @@
 ** met: http://www.gnu.org/copyleft/gpl.html.
 **
-** If you are unsure which license is appropriate for your use, please
-** contact the sales department at qt-sales@nokia.com.
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
 ** $QT_END_LICENSE$
 **
@@ -64 +64 @@
     which blocks until the operation is complete or the timeout expires.
 
-    Note that this feature is not supported on Window 9x.
+    Note that this feature is not supported on versions of Windows earlier than
+    Windows XP.
 
     \sa QLocalServer
@@ -103 +104 @@
     specified by \a socketState.
 
-    Note: It is not possible to initialize two local sockets with the same
+    \note It is not possible to initialize two local sockets with the same
     native socket descriptor.
 
@@ -208 +209 @@
     returns false.
 
-    Note: The socket's state must be ConnectedState before reading
+    \note The socket's state must be ConnectedState before reading
     and writing can occur.
 
-    \sa state()
+    \sa state(), connectToServer()
 */
 
@@ -244 +245 @@
 
 /*!
-    \fn bool QLocalSocket::waitForConnected(int msec)
-
-    Waits until the socket is connected, up to \a msec milliseconds. If the
+    \fn bool QLocalSocket::waitForConnected(int msecs)
+
+    Waits until the socket is connected, up to \a msecs milliseconds. If the
     connection has been established, this function returns true; otherwise
     it returns false. In the case where it returns false, you can call
@@ -256 +257 @@
     \snippet doc/src/snippets/code/src_network_socket_qlocalsocket_unix.cpp 0
 
-    If msecs is -1, this function will not time out.
+    If \a msecs is -1, this function will not time out.
 
     \sa connectToServer(), connected()
@@ -275 +276 @@
     \snippet doc/src/snippets/code/src_network_socket_qlocalsocket_unix.cpp 1
 
-    If msecs is -1, this function will not time out.
+    If \a msecs is -1, this function will not time out.
 
     \sa disconnectFromServer(), close()
@@ -310 +311 @@
 
     QLocalSocket::LocalSocketError is not a registered metatype, so for queued
-    connections, you will have to register it with Q_DECLARE_METATYPE.
-
-    \sa error(), errorString()
+    connections, you will have to register it with Q_DECLARE_METATYPE() and
+    qRegisterMetaType().
+
+    \sa error(), errorString(), {Creating Custom Qt Types}
 */
 
@@ -322 +324 @@
 
     QLocalSocket::SocketState is not a registered metatype, so for queued
-    connections, you will have to register it with Q_DECLARE_METATYPE.
-
-    \sa state()
+    connections, you will have to register it with Q_DECLARE_METATYPE() and
+    qRegisterMetaType().
+
+    \sa state(), {Creating Custom Qt Types}
 */
 
@@ -366 +369 @@
     Returns the server path that the socket is connected to.
 
-    Note: This is platform specific
+    \note The return value of this function is platform specific.
 
     \sa connectToServer(), serverName()
@@ -469 +472 @@
         break;
     default:
-        debug << "QLocalSocket::SocketError(" << int(error) << ")";
+        debug << "QLocalSocket::SocketError(" << int(error) << ')';
         break;
     }
@@ -491 +494 @@
         break;
     default:
-        debug << "QLocalSocket::SocketState(" << int(state) << ")";
+        debug << "QLocalSocket::SocketState(" << int(state) << ')';
         break;
     }