VivoKey/vsmartcard
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

fixed generation of documentation

Browse Source
This commit is contained in:
Frank Morgner
2012-12-11 22:56:48 +01:00
parent e9e5c7668b
commit fe155bb002
3 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
npa/doc/Makefile.am
View File

@@ -18,6 +18,8 @@ do_subst = $(SED) \
EXTRA_DIST = README.rst.in README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in EXTRA_DIST = README.rst.in README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in
DOXYGEN = doxygen
doc: $(top_srcdir)/src/npa/*.h *.in doc: $(top_srcdir)/src/npa/*.h *.in
$(do_subst) < Doxyfile.in > Doxyfile $(do_subst) < Doxyfile.in > Doxyfile
$(DOXYGEN) Doxyfile $(DOXYGEN) Doxyfile

6
npa/doc/README.rst.in
View File

@@ -30,8 +30,10 @@ The @PACKAGE_NAME@ offers an easy to use API for the new German identity card
which could also be used for other cards. The included |npa-tool| can which could also be used for other cards. The included |npa-tool| can
be used for PIN management or to send APDUs inside a secure channel. be used for PIN management or to send APDUs inside a secure channel.
The @PACKAGE_NAME@ is implemented using OpenPACE_. Some fragments of the The @PACKAGE_NAME@ is implemented using OpenPACE_ and OpenSC_. @PACKAGE_NAME@
source code are based on the source code of the OpenSC_ tools. implements and initializes Secure Messaging wrappers of OpenSC to allow a
transparent SM usage in OpenSC. This allows @PACKAGE_NAME@ to be fully
compatible with OpenSC.
.. _npa-install: .. _npa-install:

18
npa/doc/api.rst
View File

@@ -26,9 +26,9 @@ Please consider the following overview to the API as incomplete. The `Doxygen
documentation <../_static/doxygen-npa/modules.html>`_ should be used as programmer's documentation <../_static/doxygen-npa/modules.html>`_ should be used as programmer's
reference since it is more detailed. reference since it is more detailed.
===================== ======================================
Secure Messaging (SM) Generic ISO 7816 Secure Messaging (SM)
===================== ======================================
The complete documentation can be found `here The complete documentation can be found `here
<../_static/doxygen-npa/group__sm.html>`__. <../_static/doxygen-npa/group__sm.html>`__.
@@ -36,13 +36,15 @@ The complete documentation can be found `here
----- -----
Types Types
----- -----
.. doxygenstruct:: sm_ctx .. doxygenstruct:: iso_sm_ctx
--------- ---------
Functions Functions
--------- ---------
.. doxygenfunction:: sm_transmit_apdu .. doxygenfunction:: iso_sm_ctx_create
.. doxygenfunction:: sm_ctx_clear_free .. doxygenfunction:: iso_sm_ctx_clear_free
.. doxygenfunction:: iso_sm_start
.. doxygenfunction:: sm_stop
============================================================== ==============================================================
Interface to German identity card (neuer Personalausweis, nPA) Interface to German identity card (neuer Personalausweis, nPA)
@@ -54,7 +56,9 @@ The complete documentation can be found `here
--------- ---------
Functions Functions
--------- ---------
.. doxygenfunction:: EstablishPACEChannel .. doxygenfunction:: perform_pace
.. doxygenfunction:: perform_terminal_authentication
.. doxygenfunction:: perform_chip_authentication
.. doxygenfunction:: npa_reset_retry_counter .. doxygenfunction:: npa_reset_retry_counter
------- -------