X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/f3143629476bae20f5310bbc0a59fe735b5d245d..3e6c8174ae89d13ae936129b0844d3fab5778152:/armor.c

diff --git a/armor.c b/armor.c
index 397118c..230510a 100644
--- a/armor.c
+++ b/armor.c
@@ -1,9 +1,21 @@
-/*
- * armor.c - Routines to (de)armor OpenPGP packet streams.
+/**
+ * @file armor.c
+ * @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.
+ *
+ * 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.
  */
 
 #include <stdlib.h>
@@ -15,9 +27,18 @@
 #include "parsekey.h"
 #include "version.h"
 
+/**
+ * @brief Line length we'll use for armored output
+ */
 #define ARMOR_WIDTH 64
 
+/**
+ * @brief CRC24 initialisation value
+ */
 #define CRC24_INIT 0xb704ceL
+/**
+ * @brief CRC24 polynomial value
+ */
 #define CRC24_POLY 0x1864cfbL
 
 /**
@@ -65,19 +86,20 @@ static unsigned char decode64(unsigned char c) {
 }
 
 /**
- *	@lastoctet: The last octet we got.
- *	@curoctet: The current octet we're expecting (0, 1 or 2).
- *	@count: The number of octets we've seen.
- *	@crc24: A running CRC24 of the data we've seen.
- *	@putchar_func: The function to output a character.
- *	@ctx: Context for putchar_func.
+ * @brief Holds the context of an ongoing ASCII armor operation
  */
 struct armor_context {
+	/** The last octet we got. */
 	unsigned char lastoctet;
+	/** The current octet we're expecting (0, 1 or 2). */
 	int curoctet;
+	/** The number of octets we've seen. */
 	int count;
+	/** A running CRC24 of the data we've seen. */
 	long crc24;
+	/** The function to output a character. */
 	int (*putchar_func)(void *ctx, size_t count, void *c);
+	/** Context for putchar_func. */
 	void *ctx;
 };
 
@@ -198,19 +220,20 @@ static int armor_putchar(void *ctx, size_t count, void *c)
 }
 
 /**
- *	@lastoctet: The last octet we got.
- *	@curoctet: The current octet we're expecting (0, 1 or 2).
- *	@count: The number of octets we've seen.
- *	@crc24: A running CRC24 of the data we've seen.
- *	@putchar_func: The function to output a character.
- *	@ctx: Context for putchar_func.
+ * @brief Holds the context of an ongoing ASCII dearmor operation
  */
 struct dearmor_context {
+	/** The last octet we got. */
 	unsigned char lastoctet;
+	/** The current octet we're expecting (0, 1 or 2). */
 	int curoctet;
+	/** The number of octets we've seen. */
 	int count;
+	/** A running CRC24 of the data we've seen. */
 	long crc24;
+	/** The function to get the next character. */
 	int (*getchar_func)(void *ctx, size_t count, void *c);
+	/** Context for getchar_func. */
 	void *ctx;
 };
 
@@ -302,15 +325,6 @@ static int dearmor_getchar_c(void *ctx, size_t count, void *c)
 	return rc;
 }
 
-/**
- *	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.
- *
- *	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,
 						void *c),
 				void *ctx,
@@ -341,16 +355,6 @@ int armor_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
 	return 0;
 }
 
-/**
- *	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.
- *
- *	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,
 						void *c),
 				void *ctx,