Fix documentation of QLocalServer

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>
This commit is contained in:
Shane Kearns 2012-05-02 15:13:01 +01:00 committed by Qt by Nokia
parent 1eac22a1b9
commit 5fb7b7322e

View File

@ -84,19 +84,20 @@ QT_BEGIN_NAMESPACE
/*! /*!
\enum QLocalServer::SocketOption \enum QLocalServer::SocketOption
\since 5.0
This enum describes the possible options that can be used to create the This enum describes the possible options that can be used to create the
socket. This changes the access permissions on platforms (Linux, Windows) socket. This changes the access permissions on platforms (Linux, Windows)
that support access permissions on the socket. Both GroupAccess and OtherAccess that support access permissions on the socket. Both GroupAccess and OtherAccess
may vary slightly in meanings depending on the platform. 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. 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. 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. Access is available to everyone but the user and group that created the socket on Linux.
\value WorldAccess \value WorldAccessOption
No access restrictions. No access restrictions.
\sa SocketOptions \sa SocketOptions
@ -162,6 +163,7 @@ void QLocalServer::setSocketOptions(SocketOptions options)
} }
/*! /*!
\since 5.0
Returns the socket options set on the socket. Returns the socket options set on the socket.
\sa setSocketOptions() \sa setSocketOptions()