crewID/libnfc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation: fix str_nfc_target() explanation

Browse source
This commit is contained in:
Romuald Conty 2015-05-18 20:08:33 +02:00
parent ef74d81a8b
commit 22078a8509
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
libnfc/nfc.c
View file

@ -1342,10 +1342,11 @@ str_nfc_modulation_type(const nfc_modulation_type nmt)
} }
/** @ingroup string-converter /** @ingroup string-converter
* @brief Convert \a nfc_modulation_type value to string * @brief Convert \a nfc_target content to string
* @return Upon successful return, this function returns the number of characters printed (excluding the null byte used to end output to strings), otherwise returns libnfc's error code (negative value) * @return Upon successful return, this function returns the number of characters printed (excluding the null byte used to end output to strings), otherwise returns libnfc's error code (negative value)
* @param nt \a nfc_target struct to print * @param pnt \a nfc_target struct pointer to print
* @param buf pointer where string will be allocated, then nfc target information printed * @param buf pointer where string will be allocated, then nfc target information printed
* @param verbose false for essential, true for detailed, human-readable, information
* *
* @warning *buf must be freed using nfc_free() * @warning *buf must be freed using nfc_free()
*/ */