From f95a494e9753b7b8f959dbc32fe739cd27f7154e Mon Sep 17 00:00:00 2001
From: Rafal Szczesniak <mimir@samba.org>
Date: Wed, 27 Jul 2005 21:59:16 +0000
Subject: r8808: More comments.

rafal
(This used to be commit da7a31d7073d156ef5c593578a05fecf770ebc93)
---
 source4/libnet/userman.c | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

(limited to 'source4')

diff --git a/source4/libnet/userman.c b/source4/libnet/userman.c
index ef7f2658c4..6db4d17685 100644
--- a/source4/libnet/userman.c
+++ b/source4/libnet/userman.c
@@ -465,6 +465,9 @@ struct usermod_state {
 };
 
 
+/**
+ * Step 1: Lookup user name
+ */
 static NTSTATUS usermod_lookup(struct composite_context *c,
 			       struct usermod_state *s)
 {
@@ -497,6 +500,9 @@ static NTSTATUS usermod_lookup(struct composite_context *c,
 }
 
 
+/**
+ * Stage 2: Open user account
+ */
 static NTSTATUS usermod_open(struct composite_context *c,
 			     struct usermod_state *s)
 {
@@ -577,6 +583,9 @@ static NTSTATUS usermod_open(struct composite_context *c,
 }
 
 
+/**
+ * Stage 3: Set new user account data
+ */
 static NTSTATUS usermod_modify(struct composite_context *c,
 			       struct usermod_state *s)
 {
@@ -589,6 +598,13 @@ static NTSTATUS usermod_modify(struct composite_context *c,
 }
 
 
+/**
+ * Event handler for asynchronous request. Handles transition through
+ * intermediate stages of the call.
+ *
+ * @param req rpc call context
+ */
+
 static void usermod_handler(struct rpc_request *req)
 {
 	struct composite_context *c = req->async.private;
@@ -622,6 +638,13 @@ static void usermod_handler(struct rpc_request *req)
 }
 
 
+/**
+ * Sends asynchronous usermod request
+ *
+ * @param p dce/rpc call pipe
+ * @param io arguments and results of the call
+ */
+
 struct composite_context *libnet_rpc_usermod_send(struct dcerpc_pipe *p,
 						  struct libnet_rpc_usermod *io)
 {
@@ -661,6 +684,15 @@ failure:
 }
 
 
+/**
+ * Waits for and receives results of asynchronous usermod call
+ *
+ * @param c composite context returned by asynchronous usermod call
+ * @param mem_ctx memory context of the call
+ * @param io pointer to results (and arguments) of the call
+ * @return nt status code of execution
+ */
+
 NTSTATUS libnet_rpc_usermod_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
 				 struct libnet_rpc_usermod *io)
 {
@@ -674,6 +706,15 @@ NTSTATUS libnet_rpc_usermod_recv(struct composite_context *c, TALLOC_CTX *mem_ct
 }
 
 
+/**
+ * Synchronous version of usermod call
+ *
+ * @param pipe dce/rpc call pipe
+ * @param mem_ctx memory context for the call
+ * @param io arguments and results of the call
+ * @return nt status code of execution
+ */
+
 NTSTATUS libnet_rpc_usermod(struct dcerpc_pipe *pipe,
 			    TALLOC_CTX *mem_ctx,
 			    struct libnet_rpc_usermod *io)
-- 
cgit