From ea4c81ef6f5c1af10e8dbeaa1bc563a488a56639 Mon Sep 17 00:00:00 2001
From: frankmorgner <frankmorgner@96b47cad-a561-4643-ad3b-153ac7d7599c>
Date: Mon, 24 Oct 2011 19:23:44 +0000
Subject: [PATCH] documentation: grouping and other things

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@565 96b47cad-a561-4643-ad3b-153ac7d7599c
---
 npa/src/npa/npa.h    | 24 ++++++++++++++++++------
 npa/src/npa/scutil.h | 11 +++++++++++
 npa/src/npa/sm.h     | 11 +++++++----
 3 files changed, 36 insertions(+), 10 deletions(-)

diff --git a/npa/src/npa/npa.h b/npa/src/npa/npa.h
index c96ea83..3c0f7f2 100644
--- a/npa/src/npa/npa.h
+++ b/npa/src/npa/npa.h
@@ -1,23 +1,27 @@
 /*
  * Copyright (C) 2010 Frank Morgner
  *
- * This file is part of ccid.
+ * This file is part of npa.
  *
- * ccid is free software: you can redistribute it and/or modify it under the
+ * npa is free software: you can redistribute it and/or modify it under the
  * terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 3 of the License, or (at your option) any later
  * version.
  *
- * ccid is distributed in the hope that it will be useful, but WITHOUT ANY
+ * npa is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  * details.
  *
  * You should have received a copy of the GNU General Public License along with
- * ccid.  If not, see <http://www.gnu.org/licenses/>.
+ * npa.  If not, see <http://www.gnu.org/licenses/>.
  */
+/*
+*/
 /**
  * @file
+ * @defgroup npa Smart card interface to the German identity card (neuer Personalausweis, nPA)
+ * @{
  */
 #ifndef _CCID_NPA_H
 #define _CCID_NPA_H
@@ -93,6 +97,13 @@ extern "C" {
 /** Minimum length of MRZ */
 #define MAX_MRZ_LEN       128
 
+/**
+ * @brief Names the type of the PACE secret
+ *
+ * @param pin_id type of the PACE secret
+ *
+ * @return Printable string containing the name
+ */
 const char *npa_secret_name(enum s_type pin_id);
 
 
@@ -232,8 +243,8 @@ int npa_reset_retry_counter(struct sm_ctx *ctx, sc_card_t *card,
  *
  * @param[in] ctx            (optional) NPA SM context
  * @param[in] card
- * @param[in] new            (optional) new PIN
- * @param[in] new_len        (optional) length of \a new
+ * @param[in] newp           (optional) new PIN
+ * @param[in] newplen        (optional) length of \a new
  */
 #define npa_change_pin(ctx, card, newp, newplen) \
     npa_reset_retry_counter(ctx, card, PACE_PIN, 1, newp, newplen)
@@ -242,3 +253,4 @@ int npa_reset_retry_counter(struct sm_ctx *ctx, sc_card_t *card,
 }
 #endif
 #endif
+/* @} */
diff --git a/npa/src/npa/scutil.h b/npa/src/npa/scutil.h
index a56b477..f97eb86 100644
--- a/npa/src/npa/scutil.h
+++ b/npa/src/npa/scutil.h
@@ -18,6 +18,8 @@
  */
 /**
  * @file
+ * @addtogroup scutil Wrappers around OpenSC
+ * @{
  */
 #ifndef _CCID_SCUTIL_H
 #define _CCID_SCUTIL_H
@@ -64,6 +66,7 @@ int build_apdu(sc_context_t *ctx, const u8 *buf, size_t len, sc_apdu_t *apdu);
  * @brief Log binary data to a sc context
  * 
  * @param[in] ctx   Context for logging
+ * @param[in] level
  * @param[in] label Label to prepend to the buffer
  * @param[in] data  Binary data
  * @param[in] len   Length of \a data
@@ -89,6 +92,14 @@ void _bin_log(sc_context_t *ctx, int type, const char *file, int line,
         const char *func, const char *label, const u8 *data, size_t len,
         FILE *f);
 
+/**
+ * @brief Prints the available readers to stdout.
+ *
+ * @param verbose
+ *
+ * @return \c SC_SUCCESS or error code if an error occurred
+ */
 int print_avail(int verbose);
 
 #endif
+/* @} */
diff --git a/npa/src/npa/sm.h b/npa/src/npa/sm.h
index 1ecec17..d1572fc 100644
--- a/npa/src/npa/sm.h
+++ b/npa/src/npa/sm.h
@@ -1,23 +1,25 @@
 /*
  * Copyright (C) 2010 Frank Morgner
  *
- * This file is part of ccid.
+ * This file is part of npa.
  *
- * ccid is free software: you can redistribute it and/or modify it under the
+ * npa is free software: you can redistribute it and/or modify it under the
  * terms of the GNU General Public License as published by the Free Software
  * Foundation, either version 3 of the License, or (at your option) any later
  * version.
  *
- * ccid is distributed in the hope that it will be useful, but WITHOUT ANY
+ * npa is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  * details.
  *
  * You should have received a copy of the GNU General Public License along with
- * ccid.  If not, see <http://www.gnu.org/licenses/>.
+ * npa.  If not, see <http://www.gnu.org/licenses/>.
  */
 /**
  * @file
+ * @defgroup sm Secure Messaging
+ * @{
  */
 #ifndef _CCID_SM_H
 #define _CCID_SM_H
@@ -110,3 +112,4 @@ void sm_ctx_clear_free(const struct sm_ctx *sctx);
 }
 #endif
 #endif
+/* @} */