svn commit: samba r5256 - in branches/SAMBA_4_0/source/libnet: .

[mimir at samba.org]

Author: mimir
Date: 2005-02-06 23:06:27 +0000 (Sun, 06 Feb 2005)
New Revision: 5256

WebSVN: http://websvn.samba.org/cgi-bin/viewcvs.cgi?view=rev&root=samba&rev=5256

Log:
More verbose description of functions (as I learn the code).


rafal


Modified:
   branches/SAMBA_4_0/source/libnet/libnet_rpc.c


Changeset:
Modified: branches/SAMBA_4_0/source/libnet/libnet_rpc.c
===================================================================
--- branches/SAMBA_4_0/source/libnet/libnet_rpc.c	2005-02-06 16:50:54 UTC (rev 5255)
+++ branches/SAMBA_4_0/source/libnet/libnet_rpc.c	2005-02-06 23:06:27 UTC (rev 5256)
@@ -22,7 +22,15 @@
 #include "libcli/nbt/libnbt.h"
 #include "libnet/libnet.h"
 
-/* find a domain pdc generic */
+/**
+ * Finds a domain pdc (generic part)
+ * 
+ * @param ctx initialised libnet context
+ * @param mem_ctx memory context of this call
+ * @param r data structure containing necessary parameters and return values
+ * @return nt status of the call
+ **/
+
 static NTSTATUS libnet_find_pdc_generic(struct libnet_context *ctx, TALLOC_CTX *mem_ctx, 
 					union libnet_find_pdc *r)
 {
@@ -51,7 +59,16 @@
 	return NT_STATUS_OK;
 }
 
-/* find a domain pdc */
+
+/**
+ * Finds a domain pdc function
+ * 
+ * @param ctx initialised libnet context
+ * @param mem_ctx memory context of this call
+ * @param r data structure containing necessary parameters and return values
+ * @return nt status of the call
+ **/
+
 NTSTATUS libnet_find_pdc(struct libnet_context *ctx, TALLOC_CTX *mem_ctx, union libnet_find_pdc *r)
 {
 	switch (r->generic.level) {
@@ -62,7 +79,16 @@
 	return NT_STATUS_INVALID_LEVEL;
 }
 
-/* connect to a dcerpc interface of a server */
+
+/**
+ * Connects rpc pipe on remote server
+ * 
+ * @param ctx initialised libnet context
+ * @param mem_ctx memory context of this call
+ * @param r data structure containing necessary parameters and return values
+ * @return nt status of the call
+ **/
+
 static NTSTATUS libnet_rpc_connect_standard(struct libnet_context *ctx, TALLOC_CTX *mem_ctx, union libnet_rpc_connect *r)
 {
 	NTSTATUS status;
@@ -90,7 +116,16 @@
 	return status;
 }
 
-/* connect to a dcerpc interface of a time server */
+
+/**
+ * Connects rpc pipe on domain pdc
+ * 
+ * @param ctx initialised libnet context
+ * @param mem_ctx memory context of this call
+ * @param r data structure containing necessary parameters and return values
+ * @return nt status of the call
+ **/
+
 static NTSTATUS libnet_rpc_connect_pdc(struct libnet_context *ctx, TALLOC_CTX *mem_ctx, union libnet_rpc_connect *r)
 {
 	NTSTATUS status;
@@ -119,7 +154,16 @@
 	return status;
 }
 
-/* connect to a dcerpc interface */
+
+/**
+ * Connects to rpc pipe on remote server or pdc
+ * 
+ * @param ctx initialised libnet context
+ * @param mem_ctx memory context of this call
+ * @param r data structure containing necessary parameters and return values
+ * @return nt status of the call
+ **/
+
 NTSTATUS libnet_rpc_connect(struct libnet_context *ctx, TALLOC_CTX *mem_ctx, union libnet_rpc_connect *r)
 {
 	switch (r->standard.level) {