From 8b8014198c16a11f48e13e2c11f3114cd20ad8d3 Mon Sep 17 00:00:00 2001
From: Günther Deschner <gd@samba.org>
Date: Wed, 13 Apr 2011 17:35:44 +0200
Subject: s3-util_sock: very brief documentation for open_socket_out().

The most important bit is to document that timeout is in MILLIseconds, not
seconds.

Guenther
---
 source3/lib/util_sock.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/source3/lib/util_sock.c b/source3/lib/util_sock.c
index b010c991f7..71f6a8f29c 100644
--- a/source3/lib/util_sock.c
+++ b/source3/lib/util_sock.c
@@ -983,6 +983,16 @@ NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd)
 	return NT_STATUS_OK;
 }
 
+/**
+* @brief open a socket
+*
+* @param pss a struct sockaddr_storage defining the address to connect to
+* @param port to connect to
+* @param timeout in MILLISECONDS
+* @param pfd file descriptor returned
+*
+* @return NTSTATUS code
+*/
 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
 			 int timeout, int *pfd)
 {
-- 
cgit