Changeset 16:e0caabe4ca3b in vscpl for src/hu/varadiistvan

Timestamp:

04/07/13 15:21:18 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added basic documentation

Location:

src/hu/varadiistvan/scpl/io

Files:

• LocalClientSocket.h (modified) (2 diffs)
• LocalServerSocket.h (modified) (1 diff)

src/hu/varadiistvan/scpl/io/LocalClientSocket.h

@@ -55 +55 @@
      * Construct the client socket with the given name.
      *
+     * @param name the name of the server socket
      * @param waiter the waiter to use for waiting a possible event
      * occuring on the socket. If given, the socket will be
@@ -60 +61 @@
      * function of the Connector might block as well as the reading
      * and writing buffers.
+     * @param readingCapacity the capacity of the reading buffer
+     * @param writingCapacity the capacity of the writing buffer
      */
     LocalClientSocket(const char* name, Waiter* waiter = 0,

src/hu/varadiistvan/scpl/io/LocalServerSocket.h

@@ -54 +54 @@
      * connections.
      *
+     * @param name the name of the server socket that can be used by
+     * clients to connect to this socket
      * @param waiter the waiter to use for waiting a possible event
      * occuring on the socket. If given, the socket will be