Add some Doxygen comments from InSiTo written for config.h (now gone/split up)

1 files changed, 9 insertions, 5 deletions

diff --git a/src/cert/x509/x509_ca.h b/src/cert/x509/x509_ca.h
index 9f7cb9515..1aba381bc 100644
--- a/src/cert/x509/x509_ca.h
+++ b/src/cert/x509/x509_ca.h
@@ -90,11 +90,15 @@ class BOTAN_DLL X509_CA
       PK_Signer* signer;
    };
 
-/*************************************************
-* Choose a signing format for the key            *
-*************************************************/
-BOTAN_DLL PK_Signer* choose_sig_format(const Private_Key&,
-                                       AlgorithmIdentifier&);
+/**
+* Choose the default signature format for a certain public key signature
+* scheme.
+* @param key will be the key to choose a padding scheme for
+* @param alg_id will be set to the chosen scheme
+* @returns A PK_Signer object for generating signatures
+*/
+BOTAN_DLL PK_Signer* choose_sig_format(const Private_Key& key,
+                                       AlgorithmIdentifier& alg_id);
 
 
 }