Skip to content

Commit

Permalink
Doxygen: Add list of tags and include sample.c source code
Browse files Browse the repository at this point in the history
git-svn-id: svn:https://svn.debian.org/svn/pcsclite/trunk/contrib@6415 0ce88b0d-b2fd-0310-8134-9614164e65ea
  • Loading branch information
LudovicRousseau committed Aug 8, 2012
1 parent 721106a commit 4ad2e02
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
21 changes: 21 additions & 0 deletions libPCSCv2part10/PCSCv2part10.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,30 @@

/**
* @file
* @defgroup API API
*
* The available PC/SC v2 part 10 tags are (from pcsc-lite 1.8.5):
*
* - PCSCv2_PART10_PROPERTY_wLcdLayout
* - PCSCv2_PART10_PROPERTY_bEntryValidationCondition
* - PCSCv2_PART10_PROPERTY_bTimeOut2
* - PCSCv2_PART10_PROPERTY_wLcdMaxCharacters
* - PCSCv2_PART10_PROPERTY_wLcdMaxLines
* - PCSCv2_PART10_PROPERTY_bMinPINSize
* - PCSCv2_PART10_PROPERTY_bMaxPINSize
* - PCSCv2_PART10_PROPERTY_sFirmwareID
* - PCSCv2_PART10_PROPERTY_bPPDUSupport
* - PCSCv2_PART10_PROPERTY_dwMaxAPDUDataSize
* - PCSCv2_PART10_PROPERTY_wIdVendor
* - PCSCv2_PART10_PROPERTY_wIdProduct
*
* Example of code:
* @include sample.c
*/

/**
* @brief Find an integer value by tag from TLV buffer
* @ingroup API
*
* @param buffer buffer received from FEATURE_GET_TLV_PROPERTIES
* @param length buffer length
Expand All @@ -44,6 +64,7 @@ int PCSCv2Part10_find_TLV_property_by_tag_from_buffer(

/**
* @brief Find a integer value by tag from a PC/SC card handle
* @ingroup API
*
* @param hCard card handle as returned by SCardConnect()
* @param tag_searched tag searched
Expand Down
4 changes: 2 additions & 2 deletions libPCSCv2part10/doxygen.conf
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE = 8
TAB_SIZE = 4

# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
Expand Down Expand Up @@ -708,7 +708,7 @@ EXCLUDE_SYMBOLS =
# directories that contain example code fragments that are included (see
# the \include command).

EXAMPLE_PATH =
EXAMPLE_PATH = .

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Expand Down

0 comments on commit 4ad2e02

Please sign in to comment.