X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/0f4971d043c38bae1bfb95201622a1405110f899..b7a8b5277d37b289361ff0cc881632f527e4d5db:/armor.h?ds=inline

diff --git a/armor.h b/armor.h
index 7b8cd34..0006bf5 100644
--- a/armor.h
+++ b/armor.h
@@ -1,11 +1,21 @@
-/*
- * armor.h - Routines to (de)armor OpenPGP packet streams.
+/**
+ * @file armor.h
+ * @brief Routines to (de)armor OpenPGP packet streams.
+ *
+ * Copyright 2002-2004, 2011 Jonathan McDowell <noodles@earth.li>
  *
- * Jonathan McDowell <noodles@earth.li>
+ * 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 the Free
+ * Software Foundation; version 2 of the License.
  *
- * Copyright 2002 Project Purple
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
  *
- * $Id: armor.h,v 1.4 2003/06/04 20:57:07 noodles Exp $
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef __ARMOR_H__
@@ -14,31 +24,31 @@
 #include "keystructs.h"
 
 /**
- *	armor_openpgp_stream - Takes a list of OpenPGP packets and armors it.
- *	@putchar_func: The function to output the next armor character.
- *	@ctx: The context pointer for putchar_func.
- *	@packets: The list of packets to output.
+ * @brief Takes a list of OpenPGP packets and armors it.
+ * @param putchar_func The function to output the next armor character.
+ * @param ctx The context pointer for putchar_func.
+ * @param packets The list of packets to output.
  *
- *	This function ASCII armors a list of OpenPGP packets and outputs it
- *	using putchar_func.
+ * This function ASCII armors a list of OpenPGP packets and outputs it
+ * using putchar_func.
  */
 int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
-						unsigned char *c),
+						void *c),
 				void *ctx,
 				struct openpgp_packet_list *packets);
 
 /**
- *	dearmor_openpgp_stream - Reads & decodes an ACSII armored OpenPGP msg.
- *	@getchar_func: The function to get the next character from the stream.
- *	@ctx: The context pointer for getchar_func.
- *	@packets: The list of packets.
+ * @brief Reads & decodes an ACSII armored OpenPGP msg.
+ * @param getchar_func The function to get the next character from the stream.
+ * @param ctx The context pointer for getchar_func.
+ * @param packets The list of packets.
  *
- *	This function uses getchar_func to read characters from an ASCII
- *	armored OpenPGP stream and outputs the data as a linked list of
- *	packets.
+ * This function uses getchar_func to read characters from an ASCII
+ * armored OpenPGP stream and outputs the data as a linked list of
+ * packets.
  */
 int dearmor_openpgp_stream(int (*getchar_func)(void *ctx, size_t count,
-					unsigned char *c),
+					void *c),
 				void *ctx,
 				struct openpgp_packet_list **packets);