Changeset 236

Timestamp:

10/14/05 12:50:08

Author:

ben

Message:

Gasp! Ben adds docco!

Files:

• openpgpsdk/trunk/Makefile (modified) (1 diff)
• openpgpsdk/trunk/src/doxygen.c (modified) (1 diff)
• openpgpsdk/trunk/src/signature.c (modified) (3 diffs)

openpgpsdk/trunk/Makefile

@@ -41 +41 @@
-test::
-        cd examples && make test
+
+doc::
+        cd doc && make

openpgpsdk/trunk/src/doxygen.c

@@ -64 +64 @@
-/**
- * @defgroup Utils Utils
-
+
+
+
+
+
+
- * @ingroup PublicAPI
- */

openpgpsdk/trunk/src/signature.c

@@ -206 +206 @@
-    }
-
+/**
+ * \ingroup Verify
+ *
+ * Verify a certification signature.
+ *
+ * \param key The public key that was signed.
+ * \param id The user ID that was signed.
+ * \param sig The signature.
+ * \param signer The public key of the signer.
+ * \param raw_packet The raw signature packet.
+ */
-ops_boolean_t
-ops_check_certification_signature(const ops_public_key_t *key,
@@ -229 +240 @@
-    }
-
+/**
+ * \ingroup Verify
+ *
+ * Verify a subkey signature.
+ *
+ * \param key The public key whose subkey was signed.
+ * \param subkey The subkey of the public key that was signed.
+ * \param sig The signature.
+ * \param signer The public key of the signer.
+ * \param raw_packet The raw signature packet.
+ */
-ops_boolean_t
-ops_check_subkey_signature(const ops_public_key_t *key,
@@ -244 +266 @@
-    }
-
+/**
+ * \ingroup Verify
+ *
+ * Verify a signature on a hash (the hash will have already been fed
+ * the material that was being signed, for example signed cleartext).
+ *
+ * \param hash A hash structure of appropriate type that has been fed
+ * the material to be signed. This MUST NOT have been finalised.
+ * \param sig The signature to be verified.
+ * \param signer The public key of the signer.  */
-ops_boolean_t
-ops_check_hash_signature(ops_hash_t *hash,