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

-Removed README.dox from ccid Doxyfile inputs

Browse Source 
-Started to use breathe to integrate Doxygen documentation into sphinx


git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@551 96b47cad-a561-4643-ad3b-153ac7d7599c
This commit is contained in:
oepen
2011-10-13 15:28:27 +00:00
parent 4766e77320
commit 7717354b4f
5 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ccid/Doxyfile.in
View File

@@ -2,7 +2,7 @@ PROJECT_NAME = @PACKAGE_NAME@
PROJECT_NUMBER = @PACKAGE_VERSION@ PROJECT_NUMBER = @PACKAGE_VERSION@
OUTPUT_DIRECTORY = @builddir@/doc OUTPUT_DIRECTORY = @builddir@/doc
STRIP_FROM_PATH = @top_srcdir@/src STRIP_FROM_PATH = @top_srcdir@/src
INPUT = @top_srcdir@/src @top_srcdir@/README.dox INPUT = @top_srcdir@/src
FILE_PATTERNS = *.c *.h FILE_PATTERNS = *.c *.h
EXCLUDE_PATTERNS = */opensc/* EXCLUDE_PATTERNS = */opensc/*
RECURSIVE = YES RECURSIVE = YES

6
ccid/README.dox
View File

@@ -68,4 +68,10 @@ Questions
For questions, please use http://sourceforge.net/projects/vsmartcard/support For questions, please use http://sourceforge.net/projects/vsmartcard/support
=========
API index
=========
.. doxygenindex::
.. @author Frank Morgner <morgner@informatik.hu-berlin.de> .. @author Frank Morgner <morgner@informatik.hu-berlin.de>

7
doc/conf.py
View File

@@ -11,7 +11,7 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys, os import sys, os, breathe
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
@@ -25,7 +25,7 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [] extensions = ["breathe"]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@@ -214,3 +214,6 @@ man_pages = [
('index', 'virtualsmartcardarchitecture', u'Virtual Smartcard Architecture Documentation', ('index', 'virtualsmartcardarchitecture', u'Virtual Smartcard Architecture Documentation',
[u'Dominik Oepen, Frank Morgner'], 1) [u'Dominik Oepen, Frank Morgner'], 1)
] ]
breathe_projects = {"ccid": "doxygen/ccid"}
breathe_default_project = "ccid"

1
doc/doxygen/ccid Symbolic link
View File

@@ -0,0 +1 @@
../../ccid/doc/xml/

1
doc/doxygen/npa Symbolic link
View File

@@ -0,0 +1 @@
../../npa/doc/xml/