From 6cb29385b8416c5912322bc783d450a02aada138 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= <lha@kth.se>
Date: Mon, 16 Feb 2009 18:36:56 +0000
Subject: [PATCH] doxygen

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@24728 ec53bebd-3082-4978-b11e-865c3cabbd6b
---
 lib/gssapi/mech/gss_aeap.c | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/lib/gssapi/mech/gss_aeap.c b/lib/gssapi/mech/gss_aeap.c
index 3d7f793b7..2519df4da 100644
--- a/lib/gssapi/mech/gss_aeap.c
+++ b/lib/gssapi/mech/gss_aeap.c
@@ -8,15 +8,21 @@ RCSID("$Id$");
 /**
  * Encrypts or sign the data.
  *
- * There can only be one GSS_IOV_BUFFER_TYPE_DATA buffer.
- * There can be as 0 or more GSS_IOV_BUFFER_TYPE_SIGN_ONLY buffers.
+ * The maximum packet size is gss_context_stream_sizes.max_msg_size.
  *
- * The caller needs provide either:
+ * The caller needs provide the folloing buffers:
  *
- * - one GSS_IOV_BUFFER_TYPE_HEADER, one GSS_IOV_BUFFER_TYPE_PADDING, andd one GSS_IOV_BUFFER_TYPE_TRAILER
- * - on DCE-RPC mode, only one GSS_IOV_BUFFER_TYPE_HEADER may be given
+ * - HEADER (of size gss_context_stream_sizes.header)
+ *   SIGN_ONLY (optional, zero or more)
+ *   DATA
+ *   SIGN_ONLY (optional, zero or more)
+ *   PADDING (of size gss_context_stream_sizes.blocksize)
+ *   TRAILER (of size gss_context_stream_sizes.trailer)
  *
- * To generate gss_wrap() comptaible headers, use: HEADER | DATA | PADDING | TRAILER
+ * - on DCE-RPC mode, the caller can skip PADDING and TRAILER if the
+ *   DATA elements is padded to a block bountry.
+ *
+ * To generate gss_wrap() compatible packets, use: HEADER | DATA | PADDING | TRAILER
  *
  * The input sizes of HEADER, PADDING and TRAILER can be fetched using gss_wrap_iov_length() or
  * gss_context_query_attributes().