[pkg-opensc-commit] [pkcs11-helper] 46/253: Documentation update

[Eric Dorland]

This is an automated email from the git hooks/post-receive script.

eric pushed a commit to branch master
in repository pkcs11-helper.

commit 175c995920cd88d7c50d509bcd74a8f96718e31d
Author: Alon Bar-Lev <alon.barlev at gmail.com>
Date:   Tue Dec 19 20:13:17 2006 +0000

    Documentation update
---
 include/pkcs11-helper-1.0/pkcs11h-certificate.h | 11 +++++++++++
 include/pkcs11-helper-1.0/pkcs11h-core.h        | 21 ++++++++++++++++-----
 include/pkcs11-helper-1.0/pkcs11h-data.h        | 11 +++++++++++
 include/pkcs11-helper-1.0/pkcs11h-engines.h     | 11 +++++++++++
 include/pkcs11-helper-1.0/pkcs11h-openssl.h     | 11 +++++++++++
 include/pkcs11-helper-1.0/pkcs11h-token.h       | 11 +++++++++++
 6 files changed, 71 insertions(+), 5 deletions(-)

diff --git a/include/pkcs11-helper-1.0/pkcs11h-certificate.h b/include/pkcs11-helper-1.0/pkcs11h-certificate.h
index d2f427e..41e7a9e 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-certificate.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-certificate.h
@@ -50,9 +50,18 @@
  */
 
 /**
+ * @addtogroup pkcs11h_certificate Certificate interface
+ *
+ * X.509 certificate interface, provides signature and decryption.
+ *
+ * @{
+ */
+
+/**
  * @file pkcs11h-certificate.h
  * @brief pkcs11-helper certificate functions.
  * @author Alon Bar-Lev <alon.barlev at gmail.com>
+ * @see pkcs11h_certificate.
  */
 
 #ifndef __PKCS11H_CERTIFICATE_H
@@ -534,4 +543,6 @@ pkcs11h_certificate_enumCertificateIds (
 }
 #endif
 
+/** @} */
+
 #endif				/* __PKCS11H_CERTIFICATE_H */
diff --git a/include/pkcs11-helper-1.0/pkcs11h-core.h b/include/pkcs11-helper-1.0/pkcs11h-core.h
index a616e6c..d3d33ae 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-core.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-core.h
@@ -79,20 +79,29 @@
  * @par License
  * @ref License is dual BSD or GPL.
  * @par Modules
- * - @ref pkcs11h-core.h "Core" - Initialize library, adding providers, hooks.
- * - @ref pkcs11h-token.h "Token" - Handle tokens.
- * - @ref pkcs11h-certificate.h "Certificate" - Handle certificate objects.
- * - @ref pkcs11h-data.h "Data" - Handle data objects.
- * - @ref pkcs11h-openssl.h "OpenSSL" - OpenSSL engine support.
+ * - @ref pkcs11h_core - Initialize library, adding providers, hooks.
+ * - @ref pkcs11h_token - Handle tokens.
+ * - @ref pkcs11h_certificate - Handle certificate objects.
+ * - @ref pkcs11h_data - Handle data objects.
+ * - @ref pkcs11h_openssl - OpenSSL engine support.
  * @page License
  * @par pkcs11-helper License
  * @include COPYING
  */
 
 /**
+ * @addtogroup pkcs11h_core pkcs11-helper core interface
+ *
+ * Core functionality.
+ *
+ * @{
+ */
+
+/**
  * @file pkcs11h-core.h
  * @brief pkcs11-helper core.
  * @author Alon Bar-Lev <alon.barlev at gmail.com>
+ * @see pkcs11h_core.
  */
 
 #ifndef __PKCS11H_BASE_H
@@ -530,4 +539,6 @@ pkcs11h_plugAndPlay (void);
 }
 #endif
 
+/** @} */
+
 #endif				/* __PKCS11H_BASE_H */
diff --git a/include/pkcs11-helper-1.0/pkcs11h-data.h b/include/pkcs11-helper-1.0/pkcs11h-data.h
index 442cb04..1143d2d 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-data.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-data.h
@@ -50,9 +50,18 @@
  */
 
 /**
+ * @addtogroup pkcs11h_data Data object interface
+ *
+ * Data object manipulation.
+ *
+ * @{
+ */
+
+/**
  * @file pkcs11h-data.h
  * @brief pkcs11-helper data object support.
  * @author Alon Bar-Lev <alon.barlev at gmail.com>
+ * @see pkcs11h_data.
  */
 
 #ifndef __PKCS11H_DATA_H
@@ -186,4 +195,6 @@ pkcs11h_data_enumDataObjects (
 }
 #endif
 
+/** @} */
+
 #endif				/* __PKCS11H_DATA_H */
diff --git a/include/pkcs11-helper-1.0/pkcs11h-engines.h b/include/pkcs11-helper-1.0/pkcs11h-engines.h
index 0058386..a6f07e4 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-engines.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-engines.h
@@ -50,9 +50,18 @@
  */
 
 /**
+ * @addtogroup pkcs11h_engines Engines interface
+ *
+ * External dependencies.
+ *
+ * @{
+ */
+
+/**
  * @file pkcs11h-engines.h
  * @brief pkcs11-helper engines definitions.
  * @author Alon Bar-Lev <alon.barlev at gmail.com>
+ * @see pkcs11h_engines.
  */
 
 #ifndef __PKCS11H_ENGINES_H
@@ -211,4 +220,6 @@ pkcs11h_engine_setCrypto (
 }
 #endif
 
+/** @} */
+
 #endif				/* __PKCS11H_ENGINES_H */
diff --git a/include/pkcs11-helper-1.0/pkcs11h-openssl.h b/include/pkcs11-helper-1.0/pkcs11h-openssl.h
index e9d688a..9cfc9b7 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-openssl.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-openssl.h
@@ -50,9 +50,18 @@
  */
 
 /**
+ * @addtogroup pkcs11h_openssl OpenSSL interface
+ *
+ * OpenSSL engine to be used by OpenSSL enabled applications.
+ *
+ * @{
+ */
+
+/**
  * @file pkcs11h-openssl.h
  * @brief pkcs11-helper OpenSSL interface.
  * @author Alon Bar-Lev <alon.barlev at gmail.com>
+ * @see pkcs11h_openssl.
  */
 
 #ifndef __PKCS11H_HELPER_H
@@ -158,4 +167,6 @@ pkcs11h_openssl_session_getX509 (
 }
 #endif
 
+/** @} */
+
 #endif				/* __PKCS11H_OPENSSL_H */
diff --git a/include/pkcs11-helper-1.0/pkcs11h-token.h b/include/pkcs11-helper-1.0/pkcs11h-token.h
index d6f79e2..8c732d6 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-token.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-token.h
@@ -50,9 +50,18 @@
  */
 
 /**
+ * @addtogroup pkcs11h_token Token interface
+ *
+ * Token related functions.
+ *
+ * @{
+ */
+
+/**
  * @file pkcs11h-token.h
  * @brief pkcs11-helper token interface.
  * @author Alon Bar-Lev <alon.barlev at gmail.com>
+ * @see pkcs11h_token.
  */
 
 #ifndef __PKCS11H_TOKEN_H
@@ -201,4 +210,6 @@ pkcs11h_token_deserializeTokenId (
 }
 #endif
 
+/** @} */
+
 #endif				/* __PKCS11H_TOKEN_H */

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-opensc/pkcs11-helper.git