more documentation

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@22327 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2007-12-15 04:49:37 +00:00
parent f024645315
commit b3efcbda59
6 changed files with 17 additions and 3 deletions

View File

@@ -47,6 +47,8 @@ RCSID("$Id$");
* page_keyset), but its also possible to create a certificate * page_keyset), but its also possible to create a certificate
* directly from a parsed object with hx509_cert_init() and * directly from a parsed object with hx509_cert_init() and
* hx509_cert_init_data(). * hx509_cert_init_data().
*
* See the library functions here: @ref hx509_cert
*/ */
struct hx509_verify_ctx_data { struct hx509_verify_ctx_data {

View File

@@ -50,6 +50,8 @@ RCSID("$Id$");
* - ContentInfo * - ContentInfo
* Wrapper structure including type and data. * Wrapper structure including type and data.
* *
*
* See the library functions here: @ref hx509_cms
*/ */
#define ALLOC(X, N) (X) = calloc((N), sizeof(*(X))) #define ALLOC(X, N) (X) = calloc((N), sizeof(*(X)))

View File

@@ -69,3 +69,5 @@
/** @defgroup hx509_revoke hx509 revokation checking functions /** @defgroup hx509_revoke hx509 revokation checking functions
* See the @ref page_revoke for description and examples. */ * See the @ref page_revoke for description and examples. */
/** @defgroup hx509_verify hx509 verification functions */ /** @defgroup hx509_verify hx509 verification functions */
/** @defgroup hx509_lock hx509 lock functions
* See the @ref page_lock for description and examples. */

View File

@@ -35,7 +35,7 @@
RCSID("$Id$"); RCSID("$Id$");
/** /**
* @page page_keyset certificates store operations * @page page_keyset Certificate store operations
* *
* Type of certificates store: * Type of certificates store:
* - MEMORY * - MEMORY
@@ -52,6 +52,10 @@ RCSID("$Id$");
* - PKCS11 * - PKCS11
* - PKCS12 * - PKCS12
* - DIR * - DIR
* - KEYCHAIN
* Apple Mac OS X KeyChain backed keychain object.
*
* See the library functions here: @ref hx509_keyset
*/ */
struct hx509_certs_data { struct hx509_certs_data {
@@ -97,8 +101,8 @@ _hx509_ks_register(hx509_context context, struct hx509_keyset_ops *ops)
* if NULL is used the MEMORY store is used. * if NULL is used the MEMORY store is used.
* @param flags list of flags: * @param flags list of flags:
* - HX509_CERTS_CREATE create a new keystore of the specific TYPE. * - HX509_CERTS_CREATE create a new keystore of the specific TYPE.
* @param lock a @ref page_lock that unlocks the certificates store, * @param lock a lock that unlocks the certificates store, use NULL to
* use NULL to select no password/certifictes/prompt lock. * select no password/certifictes/prompt lock (see @ref page_lock).
* @param certs return pointer, free with hx509_certs_free(). * @param certs return pointer, free with hx509_certs_free().
* *
* @ingroup hx509_keyset * @ingroup hx509_keyset

View File

@@ -36,6 +36,8 @@ RCSID("$Id$");
/** /**
* @page page_lock Locking and unlocking certificates and encrypted data. * @page page_lock Locking and unlocking certificates and encrypted data.
*
* See the library functions here: @ref hx509_lock
*/ */
struct hx509_lock_data { struct hx509_lock_data {

View File

@@ -56,6 +56,8 @@ RCSID("$Id$");
* make it back into string representation with hx509_name_to_string(). * make it back into string representation with hx509_name_to_string().
* *
* Name string are defined rfc2253, rfc1779 and X.501. * Name string are defined rfc2253, rfc1779 and X.501.
*
* See the library functions here: @ref hx509_name
*/ */
static const struct { static const struct {