[pkg-opensc-commit] [pkcs11-helper] 123/253: Move out doxygen main to separate file
Eric Dorland
eric at moszumanska.debian.org
Fri Jan 6 23:39:11 UTC 2017
This is an automated email from the git hooks/post-receive script.
eric pushed a commit to branch master
in repository pkcs11-helper.
commit 6170fd3336f5fa34b1f3ce88b4bfc849792a3550
Author: Alon Bar-Lev <alon.barlev at gmail.com>
Date: Mon Aug 20 17:30:10 2007 +0000
Move out doxygen main to separate file
---
doc/api/Doxyfile | 10 +++---
doc/api/Makefile.am | 2 +-
doc/api/main.dox | 57 ++++++++++++++++++++++++++++++++
include/pkcs11-helper-1.0/pkcs11h-core.h | 55 ------------------------------
4 files changed, 62 insertions(+), 62 deletions(-)
diff --git a/doc/api/Doxyfile b/doc/api/Doxyfile
index 833b0a7..4d43e75 100644
--- a/doc/api/Doxyfile
+++ b/doc/api/Doxyfile
@@ -462,7 +462,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../../include
+INPUT = ../../include .
# This tag can be used to specify the character encoding of the source files that
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
@@ -478,7 +478,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
-FILE_PATTERNS =
+FILE_PATTERNS = *.h *.c *.dox
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@@ -490,9 +490,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = ../../include/pkcs11-helper-1.0/cryptoki.h \
- ../../include/pkcs11-helper-1.0/cryptoki-win32.h \
- ../../include/pkcs11-helper-1.0/pkcs11-headers
+EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -506,7 +504,7 @@ EXCLUDE_SYMLINKS = NO
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = */.svn/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the output.
diff --git a/doc/api/Makefile.am b/doc/api/Makefile.am
index 09993d7..35c1c12 100644
--- a/doc/api/Makefile.am
+++ b/doc/api/Makefile.am
@@ -49,7 +49,7 @@
# POSSIBILITY OF SUCH DAMAGE.
#
-EXTRA_DIST=Doxyfile Doxyfile_footer.html *.gif
+EXTRA_DIST=Doxyfile Doxyfile_footer.html *.dox *.gif
if ENABLE_DOC
diff --git a/doc/api/main.dox b/doc/api/main.dox
new file mode 100644
index 0000000..5a16e23
--- /dev/null
+++ b/doc/api/main.dox
@@ -0,0 +1,57 @@
+/**
+
+ at mainpage pkcs11-helper-1.0
+ at section about About
+ at par
+<a href="http://www.rsasecurity.com/rsalabs/pkcs/pkcs-11">PKCS#11</a>
+is
+<a href="http://www.rsasecurity.com">RSA Security</a>
+published standard. PKCS#11 is the de-facto standard to access cryptographic
+devices.
+ at par
+pkcs11-helper is a library that simplifies the interaction with PKCS#11
+providers for end-user applications.
+ at section features Features
+ at par
+pkcs11-helper allows using multiple PKCS#11 providers at the same time, enumerating
+available token certificates, or selecting a certificate directly by serialized id,
+handling card removal and card insert events, handling card re-insert to a different
+slot, supporting session expiration and much more all using a simple API.
+ at par
+pkcs11-helper is not designed to manage card content, since object attributes
+are usually vendor specific, and 99% of application need to access
+existing objects in order to perform signature and decryption.
+ at section compatibility Compatibility
+- The pkcs11-helper library is available in POSIX and WIN32 compliant systems.
+- The pkcs11-helper library should work with almost any PKCS#11 provider, since it
+ uses the minimum required features of the PKCS#11 standard.
+ at section support Support
+ at par
+pkcs11-helper support is available via the
+<a href="http://www.opensc-project.org">OpenSC Project</a>.
+ at section license License
+ at par
+ at ref License is dual BSD or GPL.
+ at section modules Modules
+- @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.
+ at page License pkcs11-helper license
+ at verbinclude COPYING
+
+*/
+
+/**
+ at example test-basic.c
+
+The following example shows some basic usage of the library.
+*/
+
+/**
+ at example test-slotevent.c
+
+The following example shows how to use the slot event interface.
+*/
+
diff --git a/include/pkcs11-helper-1.0/pkcs11h-core.h b/include/pkcs11-helper-1.0/pkcs11h-core.h
index c89fe7a..7a4b9e5 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-core.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-core.h
@@ -50,49 +50,6 @@
*/
/**
- * @mainpage pkcs11-helper-1.0
- * @section about About
- * @par
- * <a href="http://www.rsasecurity.com/rsalabs/pkcs/pkcs-11">PKCS#11</a>
- * is
- * <a href="http://www.rsasecurity.com">RSA Security</a>
- * published standard. PKCS#11 is the de-facto standard to access cryptographic
- * devices.
- * @par
- * pkcs11-helper is a library that simplifies the interaction with PKCS#11
- * providers for end-user applications.
- * @section features Features
- * @par
- * pkcs11-helper allows using multiple PKCS#11 providers at the same time, enumerating
- * available token certificates, or selecting a certificate directly by serialized id,
- * handling card removal and card insert events, handling card re-insert to a different
- * slot, supporting session expiration and much more all using a simple API.
- * @par
- * pkcs11-helper is not designed to manage card content, since object attributes
- * are usually vendor specific, and 99% of application need to access
- * existing objects in order to perform signature and decryption.
- * @section compatibility Compatibility
- * - The pkcs11-helper library is available in POSIX and WIN32 compliant systems.
- * - The pkcs11-helper library should work with almost any PKCS#11 provider, since it
- * uses the minimum required features of the PKCS#11 standard.
- * @section support Support
- * @par
- * pkcs11-helper support is available via the
- * <a href="http://www.opensc-project.org">OpenSC Project</a>.
- * @section license License
- * @par
- * @ref License is dual BSD or GPL.
- * @section modules Modules
- * - @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 pkcs11-helper license
- * @verbinclude COPYING
- */
-
-/**
* @addtogroup pkcs11h_core pkcs11-helper core interface
*
* Core functionality.
@@ -107,18 +64,6 @@
* @see pkcs11h_core.
*/
-/**
- * @example test-basic.c
- *
- * The following example shows some basic usage of the library.
- */
-
-/**
- * @example test-slotevent.c
- *
- * The following example shows how to use the slot event interface.
- */
-
#ifndef __PKCS11H_BASE_H
#define __PKCS11H_BASE_H
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-opensc/pkcs11-helper.git
More information about the pkg-opensc-commit
mailing list