svn commit: samba r4530 - in branches/SAMBA_4_0/source/libcli/auth: .

[abartlet at samba.org]

Author: abartlet
Date: 2005-01-05 03:21:45 +0000 (Wed, 05 Jan 2005)
New Revision: 4530

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

Log:
Start adding a bit of Doxygen compatible documentation comments to GENSEC.

Andrew Bartlett

Modified:
   branches/SAMBA_4_0/source/libcli/auth/gensec.c


Changeset:
Modified: branches/SAMBA_4_0/source/libcli/auth/gensec.c
===================================================================
--- branches/SAMBA_4_0/source/libcli/auth/gensec.c	2005-01-05 03:19:25 UTC (rev 4529)
+++ branches/SAMBA_4_0/source/libcli/auth/gensec.c	2005-01-05 03:21:45 UTC (rev 4530)
@@ -115,8 +115,11 @@
 	return oid_list;
 }
 
-/*
-  note that memory context is the parent context to hang this gensec context off. It may be NULL.
+/**
+  Start the GENSEC system, returning a context pointer.
+  @param mem_ctx The parent TALLOC memory context.
+  @param gensec_security Returned GENSEC context pointer.
+  @note  The mem_ctx is only a parent and may be NULL.
 */
 static NTSTATUS gensec_start(TALLOC_CTX *mem_ctx, struct gensec_security **gensec_security) 
 {
@@ -142,7 +145,9 @@
 
 /** 
  * Start a GENSEC subcontext, with a copy of the properties of the parent
- *
+ * @param mem_ctx The parent TALLOC memory context.
+ * @param parent The parent GENSEC context 
+ * @param gensec_security Returned GENSEC context pointer.
  * @note Used by SPENGO in particular, for the actual implementation mechanism
  */
 
@@ -164,6 +169,12 @@
 	return NT_STATUS_OK;
 }
 
+/**
+  Start the GENSEC system, in client mode, returning a context pointer.
+  @param mem_ctx The parent TALLOC memory context.
+  @param gensec_security Returned GENSEC context pointer.
+  @note  The mem_ctx is only a parent and may be NULL.
+*/
 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx, struct gensec_security **gensec_security)
 {
 	NTSTATUS status;
@@ -179,6 +190,12 @@
 	return status;
 }
 
+/**
+  Start the GENSEC system, in server mode, returning a context pointer.
+  @param mem_ctx The parent TALLOC memory context.
+  @param gensec_security Returned GENSEC context pointer.
+  @note  The mem_ctx is only a parent and may be NULL.
+*/
 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx, struct gensec_security **gensec_security)
 {
 	NTSTATUS status;
@@ -222,6 +239,9 @@
 
 /** 
  * Start a GENSEC sub-mechanism by DCERPC allocated 'auth type' number 
+ * @param gensec_security GENSEC context pointer.
+ * @param auth_type DCERPC auth type
+ * @param auth_level DCERPC auth level 
  */
 
 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,