Add doc for NFCTarget

pull/7822/head
Donatien Garnier 2018-08-07 17:30:24 +01:00
parent 39879b7d9d
commit b0f1f4304c
1 changed files with 37 additions and 2 deletions

View File

@ -26,17 +26,52 @@
namespace mbed {
namespace nfc {
class NFCEEPROM : public NFCTarget {
/**
* @addtogroup nfc
* @{
*/
/**
* The NFC EEPROM class represents a NFC target device connected using a wired
* link (I2C, SPI, etc).
*
* These EEPROMs essentially provide addressable memory that can be accessed
* using either a wired or NFC interface.
*
* In NFC mode these most often conform to one of the NFC tag types defined
* by the NFC Forum, therefore encoding NDEF data in these EEPROMs will
* ensure that it is understandable by a NFC reader.
*/
class NFCEEPROM : public NFCTarget {
public:
NFCEEPROM();
/**
* Construct a NFCEEPROM instance.
*
* @param[in] driver a pointer to a NFCEEPROMDriver instance
*/
NFCEEPROM(NFCEEPROMDriver* driver);
virtual ~NFCTarget();
/**
* The NFCEEPROM delegate. Users of the NFCEEPROM class need to implement this delegate's methods to receive events.
*/
struct Delegate : NFCTarget::Delegate {
};
/**
* Set the delegate that will receive events generated by this EEPROM.
*
* @oaram[in] delegate the delegate instance to use
*/
void set_delegate(Delegate* delegate);
};
/**
* @}
*/
} // namespace nfc
} // namespace mbed