[pkg-opensc-commit] [pkcs11-helper] 04/253: Doxygen cleanups

[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 fba6ae9e3ef550fc6ab49f52c261ae3f8cf87e0b
Author: Alon Bar-Lev <alon.barlev at gmail.com>
Date:   Sun Nov 26 14:10:16 2006 +0000

    Doxygen cleanups
---
 doc/api/Doxyfile                          |   2 +-
 doc/api/Doxyfile_footer.html              |   2 +-
 doc/api/Makefile.am                       |   8 ++++++--
 doc/api/opensc-logo.gif                   | Bin 0 -> 4663 bytes
 include/pkcs11-helper-1.0/pkcs11h-core.h  |   2 +-
 include/pkcs11-helper-1.0/pkcs11h-token.h |   6 +++---
 6 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/doc/api/Doxyfile b/doc/api/Doxyfile
index 6940298..3e1f2e6 100644
--- a/doc/api/Doxyfile
+++ b/doc/api/Doxyfile
@@ -433,7 +433,7 @@ WARN_IF_DOC_ERROR      = YES
 # wrong or incomplete parameter documentation, but not about the absence of 
 # documentation.
 
-WARN_NO_PARAMDOC       = NO
+WARN_NO_PARAMDOC       = YES
 
 # The WARN_FORMAT tag determines the format of the warning messages that 
 # doxygen can produce. The string should contain the $file, $line, and $text 
diff --git a/doc/api/Doxyfile_footer.html b/doc/api/Doxyfile_footer.html
index 0620e74..d94b94b 100644
--- a/doc/api/Doxyfile_footer.html
+++ b/doc/api/Doxyfile_footer.html
@@ -1,2 +1,2 @@
 <hr>
-pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev at gmail.com>
+<table width="100%"><tr><td>pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev at gmail.com></td><td align="right"><img src="opensc-logo.gif"/></td></tr></table>
diff --git a/doc/api/Makefile.am b/doc/api/Makefile.am
index 3d99e1d..0522e79 100644
--- a/doc/api/Makefile.am
+++ b/doc/api/Makefile.am
@@ -50,16 +50,20 @@
 # THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-EXTRA_DIST=Doxyfile Doxyfile_footer.html
+EXTRA_DIST=Doxyfile Doxyfile_footer.html *.gif
 
 if ENABLE_DOC
 
 apidir=$(htmldir)/api
 api_DATA=api.out/html/*
 
-api.out/html/*:	$(EXTRA_DIST) ../../include/pkcs11-helper-1.0/*.h
+api.out/html/*: \
+		$(EXTRA_DIST) \
+		../../include/pkcs11-helper-1.0/*.h \
+		*.gif
 	-rm -fr api.out
 	$(DOXYGEN)
+	cp *.gif api.out/html
 
 clean-generic:
 	-rm -fr api.out
diff --git a/doc/api/opensc-logo.gif b/doc/api/opensc-logo.gif
new file mode 100644
index 0000000..9407699
Binary files /dev/null and b/doc/api/opensc-logo.gif differ
diff --git a/include/pkcs11-helper-1.0/pkcs11h-core.h b/include/pkcs11-helper-1.0/pkcs11h-core.h
index 9338f67..82596c6 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-core.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-core.h
@@ -475,7 +475,7 @@ pkcs11h_setMaxLoginRetries (
  * @param reference		Reference name for this provider.
  * @param provider_location	Provider library location.
  * @param allow_protected_auth	Allow this provider to use protected authentication.
- * @param mask_private_mode	Provider private mode @ref PKCS11H_PRIVATE_MASK override.
+ * @param mask_private_mode	Provider private mode @ref PKCS11H_PRIVATEMODE_MASK override.
  * @param slot_event_method	Provider slot event @ref PKCS11H_SLOTEVENT_METHOD method.
  * @param slot_poll_interval	Slot event poll interval (If in polling mode).
  * @param cert_is_private	Provider's certificate access should be done after login.
diff --git a/include/pkcs11-helper-1.0/pkcs11h-token.h b/include/pkcs11-helper-1.0/pkcs11h-token.h
index d553edb..2eae2ec 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-token.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-token.h
@@ -133,9 +133,9 @@ pkcs11h_token_login (
 
 /**
  * @brief Ensure token is accessible.
- * @brief token_id	Token id object.
- * @brief user_data	Optional user data, to be passed to hooks.
- * @brief mask_prompt	Allow prompt @ref PKCS11H_PROMPT_MASK.
+ * @param token_id	Token id object.
+ * @param user_data	Optional user data, to be passed to hooks.
+ * @param mask_prompt	Allow prompt @ref PKCS11H_PROMPT_MASK.
  * @return CK_RV.
  */
 CK_RV

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