Protocol version 1.2 integrations

[silc.git] / lib / silccore / silcargument.h

diff --git a/lib/silccore/silcargument.h b/lib/silccore/silcargument.h
index 9f3eebfe6947100bcf4d7795807943bef1907170..305b690287291a5f8fb654a3c9ae482cbeea6840 100644 (file)
--- a/lib/silccore/silcargument.h
+++ b/lib/silccore/silcargument.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2001 Pekka Riikonen
+  Copyright (C) 2001 - 2002 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silccore/SilcArgumentAPI
+/****h* silccore/SILC Argument Interface
  *
  * DESCRIPTION
  *
@@ -29,6 +29,22 @@
 #ifndef SILCPAYLOAD_H
 #define SILCPAYLOAD_H
 
+/****s* silccore/SilcArgumentAPI/SilcArgumentPayload
+ *
+ * NAME
+ * 
+ *    typedef struct SilcArgumentPayloadStruct *SilcArgumentPayload;
+ *
+ * DESCRIPTION
+ *
+ *    This context is the actual Argument Payload and is allocated
+ *    by silc_argument_payload_parse and given as argument usually to
+ *    all silc_argument_payload_* functions.  It is freed by the
+ *    silc_argument_payload_free function.
+ *
+ ***/
+typedef struct SilcArgumentPayloadStruct *SilcArgumentPayload;
+
 /****f* silccore/SilcArgumentAPI/silc_argument_payload_parse
  *
  * SYNOPSIS