From 32f2eb2295db59bdd2a3aecf6276532d519e22d8 Mon Sep 17 00:00:00 2001
From: hasufell <hasufell@hasufell.de>
Date: Sun, 25 May 2014 01:11:56 +0200
Subject: [PATCH] KEYGEN: add doxygen comments

---
 src/keypair.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/keypair.h b/src/keypair.h
index 1dc8bcc..79d2eb3 100644
--- a/src/keypair.h
+++ b/src/keypair.h
@@ -33,9 +33,25 @@
 typedef struct keypair keypair;
 
 
+/**
+ * This struct holds the keypair,
+ * both private and public components.
+ */
 struct keypair {
+	/**
+	 * First part of the private key,
+	 * a random polynom.
+	 */
 	fmpz_poly_t priv;
+	/**
+	 * Second part of the private key,
+	 * the priv polynom inverted.
+	 */
 	fmpz_poly_t priv_inv;
+	/**
+	 * The public key, computed as:
+	 * h = p * (Fq * g) mod q
+	 */
 	fmpz_poly_t pub;
 };