Fix documentation of QLocalServer
authorShane Kearns <ext-shane.2.kearns@nokia.com>
Wed, 2 May 2012 14:13:01 +0000 (15:13 +0100)
committerQt by Nokia <qt-info@nokia.com>
Thu, 3 May 2012 07:02:38 +0000 (09:02 +0200)
Added \since 5.0 and corrected the enum documentation to match the
code.

Task-number: QTBUG-24001
Change-Id: I8e284b6eaaf68c46bbd0e07f4378f0c442f2edd4
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
src/network/socket/qlocalserver.cpp

index e984821..b379e99 100644 (file)
@@ -84,19 +84,20 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \enum QLocalServer::SocketOption
+    \since 5.0
 
     This enum describes the possible options that can be used to create the
     socket. This changes the access permissions on platforms (Linux, Windows)
     that support access permissions on the socket. Both GroupAccess and OtherAccess
     may vary slightly in meanings depending on the platform.
 
-    \value UserAccess
+    \value UserAccessOption
     Access is restricted to the same user as the process that created the socket.
-    \value GroupAccess
+    \value GroupAccessOption
     Access is restricted to the same group but not the user that created the socket on Linux.
-    \value OtherAccess
+    \value OtherAccessOption
     Access is available to everyone but the user and group that created the socket on Linux.
-    \value WorldAccess
+    \value WorldAccessOption
     No access restrictions.
 
     \sa SocketOptions
@@ -162,6 +163,7 @@ void QLocalServer::setSocketOptions(SocketOptions options)
 }
 
 /*!
+    \since 5.0
     Returns the socket options set on the socket.
 
     \sa setSocketOptions()