From 424a48714fccf60ace748a1398525f37488d5a89 Mon Sep 17 00:00:00 2001 From: Romuald Conty Date: Thu, 22 Jul 2010 16:16:37 +0000 Subject: [PATCH] Minor documentation improvements. --- libnfc/nfc.c | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/libnfc/nfc.c b/libnfc/nfc.c index 9f62179..cf8bd09 100644 --- a/libnfc/nfc.c +++ b/libnfc/nfc.c @@ -406,15 +406,20 @@ bool nfc_initiator_select_dep_target(const nfc_device_t* pnd, const nfc_modulati * @fn nfc_initiator_select_passive_target(const nfc_device_t* pnd, const nfc_modulation_t nmInitModulation, const byte_t* pbtInitData, const size_t szInitDataLen, nfc_target_info_t* pti) * @brief Select a passive or emulated tag * @return Returns true if action was successfully performed; otherwise returns false. + * * @param pnd nfc_device_t struct pointer that represent currently used device - * @param im Desired modulation + * @param nmInitModulation Desired modulation * @param pbtInitData Optional initiator data used for Felica, ISO14443B, Topaz Polling or for ISO14443A selecting a specific UID. * @param szInitDataLen Length of initiator data \a pbtInitData. + * @param pnti nfc_target_info_t struct pointer which will filled if available * * The NFC device will try to find the available passive tags. Some NFC devices are capable to emulate passive tags. The standards (ISO18092 and ECMA-340) describe the modulation that can be used for reader to passive communications. The chip needs to know with what kind of tag it is dealing with, therefore the initial modulation and speed (106, 212 or 424 kbps) should be supplied. * @note For every initial modulation type there is a different collection of information returned (in nfc_target_info_t pointer pti) They all fit in the data-type which is called nfc_target_info_t. This is a union which contains the tag information that belongs to the according initial modulation type. */ -bool nfc_initiator_select_passive_target(const nfc_device_t* pnd, const nfc_modulation_t nmInitModulation, const byte_t* pbtInitData, const size_t szInitDataLen, nfc_target_info_t* pnti) +bool nfc_initiator_select_passive_target(const nfc_device_t* pnd, + const nfc_modulation_t nmInitModulation, + const byte_t* pbtInitData, const size_t szInitDataLen, + nfc_target_info_t* pnti) { byte_t abtInit[MAX_FRAME_LEN]; size_t szInitLen;