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

Add doxygen comment to dev_callbacks struct.

Browse source
This commit is contained in:
Romuald Conty 2009-08-28 10:44:07 +00:00
parent 379bc51241
commit 0344b1aee2
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/types.h
View file

@ -48,7 +48,7 @@ struct dev_callbacks; // Prototype the callback struct
/** /**
* @struct dev_info * @struct dev_info
* @brief struct that describe NFC device * @brief NFC device information
*/ */
typedef struct { typedef struct {
/** Callback functions for handling device specific wrapping */ /** Callback functions for handling device specific wrapping */
@ -69,10 +69,18 @@ typedef struct {
uint8_t ui8TxBits; uint8_t ui8TxBits;
} dev_info; } dev_info;
/**
* @struct dev_callbacks
* @brief NFC defice callbacks
*/
struct dev_callbacks { struct dev_callbacks {
const char* acDriver; // Driver description /** Driver name */
const char* acDriver;
/** Connect callback */
dev_info* (*connect)(const uint32_t uiIndex); dev_info* (*connect)(const uint32_t uiIndex);
/** Transceive callback */
bool (*transceive)(const dev_spec ds, const byte_t* pbtTx, const uint32_t uiTxLen, byte_t* pbtRx, uint32_t* puiRxLen); bool (*transceive)(const dev_spec ds, const byte_t* pbtTx, const uint32_t uiTxLen, byte_t* pbtRx, uint32_t* puiRxLen);
/** Disconnect callback */
void (*disconnect)(dev_info* pdi); void (*disconnect)(dev_info* pdi);
}; };