Adding nimdoc comments as per PR comments

As per @dom96 code review comments in PR #3488
This commit is contained in:
Josh Girvin 2016-05-30 16:29:38 +10:00
commit b662d22ad1

View file

@ -583,7 +583,7 @@ proc connect*(socket: Socket, address: string,
let ret = SSLConnect(socket.sslHandle) let ret = SSLConnect(socket.sslHandle)
socketError(socket, ret) socketError(socket, ret)
when defined(posix): when defined(posix) or defined(nimdoc):
proc makeUnixAddr(path: string): Sockaddr_un = proc makeUnixAddr(path: string): Sockaddr_un =
result.sun_family = AF_UNIX.toInt result.sun_family = AF_UNIX.toInt
if path.len >= Sockaddr_un_path_length: if path.len >= Sockaddr_un_path_length:
@ -592,6 +592,7 @@ when defined(posix):
proc connectUnix*(socket: Socket, path: string) = proc connectUnix*(socket: Socket, path: string) =
## Connects to Unix socket on `path`. ## Connects to Unix socket on `path`.
## This only works on Unix-style systems: Mac OS X, BSD and Linux
var socketAddr = makeUnixAddr(path) var socketAddr = makeUnixAddr(path)
if socket.fd.connect(cast[ptr SockAddr](addr socketAddr), if socket.fd.connect(cast[ptr SockAddr](addr socketAddr),
sizeof(socketAddr).Socklen) != 0'i32: sizeof(socketAddr).Socklen) != 0'i32:
@ -599,6 +600,7 @@ when defined(posix):
proc bindUnix*(socket: Socket, path: string) = proc bindUnix*(socket: Socket, path: string) =
## Binds Unix socket to `path`. ## Binds Unix socket to `path`.
## This only works on Unix-style systems: Mac OS X, BSD and Linux
var socketAddr = makeUnixAddr(path) var socketAddr = makeUnixAddr(path)
if socket.fd.bindAddr(cast[ptr SockAddr](addr socketAddr), if socket.fd.bindAddr(cast[ptr SockAddr](addr socketAddr),
sizeof(socketAddr).Socklen) != 0'i32: sizeof(socketAddr).Socklen) != 0'i32: