mirror of https://github.com/ARMmbed/mbed-os.git
NFC: Fix doxygen issues
parent
7a473ed9cf
commit
5c24c4dd82
|
@ -73,13 +73,13 @@ public:
|
|||
|
||||
/**
|
||||
* A remote initiator was discovered (the local controller is in target mode).
|
||||
* @param[in] the NFCRemoteInitiator instance
|
||||
* @param[in] nfc_initiator the NFCRemoteInitiator instance
|
||||
*/
|
||||
virtual void on_nfc_initiator_discovered(const SharedPtr<NFCRemoteInitiator> &nfc_initiator) {}
|
||||
|
||||
/**
|
||||
* A remote target was discovered (the local controller is in initiator mode).
|
||||
* @param[in] the NFCRemoteTarget instance
|
||||
* @param[in] nfc_target the NFCRemoteTarget instance
|
||||
*/
|
||||
virtual void on_nfc_target_discovered(const SharedPtr<NFCRemoteTarget> &nfc_target) {}
|
||||
|
||||
|
@ -109,7 +109,7 @@ public:
|
|||
/**
|
||||
* Set the delegate that will receive events generated by this controller.
|
||||
*
|
||||
* @oaram[in] delegate the delegate instance to use
|
||||
* @param[in] delegate the delegate instance to use
|
||||
*/
|
||||
void set_delegate(Delegate *delegate);
|
||||
|
||||
|
|
|
@ -96,7 +96,7 @@ public:
|
|||
/**
|
||||
* Set the delegate that will receive events generated by this EEPROM.
|
||||
*
|
||||
* @oaram[in] delegate the delegate instance to use
|
||||
* @param[in] delegate the delegate instance to use
|
||||
*/
|
||||
void set_delegate(Delegate *delegate);
|
||||
|
||||
|
|
|
@ -86,7 +86,7 @@ public:
|
|||
* Completion of size retrieval operation.
|
||||
*
|
||||
* @param[in] success whether this operation succeeded
|
||||
* @param[out] the current addressable memory size
|
||||
* @param[out] size the current addressable memory size
|
||||
*/
|
||||
virtual void on_size_read(bool success, size_t size) = 0;
|
||||
|
||||
|
@ -111,7 +111,7 @@ public:
|
|||
/**
|
||||
* Set the delegate that will receive events generated by this EEPROM.
|
||||
*
|
||||
* @oaram[in] delegate the delegate instance to use
|
||||
* @param[in] delegate the delegate instance to use
|
||||
*/
|
||||
void set_delegate(Delegate *delegate);
|
||||
|
||||
|
@ -152,7 +152,7 @@ public:
|
|||
* @param[in] address the virtual address (starting from 0) from which to start the read.
|
||||
* @param[out] bytes a buffer in which the read bytes will be stored.
|
||||
* This buffer should remain valid till the callback is called.
|
||||
* @oaram[in] count the number of bytes to read.
|
||||
* @param[in] count the number of bytes to read.
|
||||
* This method should complete asynchronously by calling has_read_bytes().
|
||||
*/
|
||||
virtual void read_bytes(uint32_t address, uint8_t *bytes, size_t count) = 0;
|
||||
|
@ -162,7 +162,7 @@ public:
|
|||
* @param[in] address the virtual address (starting from 0) from which to start the write.
|
||||
* @param[in] bytes a buffer from to copy.
|
||||
* This buffer should remain valid till the callback is called.
|
||||
* @oaram[in] count the number of bytes to write.
|
||||
* @param[in] count the number of bytes to write.
|
||||
* This method should complete asynchronously by calling has_written_bytes().
|
||||
*/
|
||||
virtual void write_bytes(uint32_t address, const uint8_t *bytes, size_t count) = 0;
|
||||
|
@ -175,7 +175,7 @@ public:
|
|||
|
||||
/**
|
||||
* Set the size of the addressable memory.
|
||||
* @oaram[in] count the number of addressable bytes.
|
||||
* @param[in] count the number of addressable bytes.
|
||||
* This method should complete asynchronously by calling has_set_size().
|
||||
*/
|
||||
virtual void write_size(size_t count) = 0;
|
||||
|
@ -183,7 +183,7 @@ public:
|
|||
/**
|
||||
* Erase bytes from memory.
|
||||
* @param[in] address the virtual address (starting from 0) from which to start erasing.
|
||||
* @oaram[in] count the number of bytes to erase.
|
||||
* @param[in] size the number of bytes to erase.
|
||||
* This method should complete asynchronously by calling has_erased_bytes().
|
||||
*/
|
||||
virtual void erase_bytes(uint32_t address, size_t size) = 0;
|
||||
|
|
|
@ -84,7 +84,7 @@ public:
|
|||
/**
|
||||
* Set the delegate that will receive events generated by this class.
|
||||
*
|
||||
* @oaram[in] delegate the delegate instance to use
|
||||
* @param[in] delegate the delegate instance to use
|
||||
*/
|
||||
void set_ndef_delegate(Delegate *delegate);
|
||||
|
||||
|
@ -92,14 +92,14 @@ protected:
|
|||
/**
|
||||
* Parse a NDEF message.
|
||||
*
|
||||
* @param[in] a buffer containing a NDEF message
|
||||
* @param[in] buffer a buffer containing a NDEF message
|
||||
*/
|
||||
void parse_ndef_message(const ac_buffer_t &buffer);
|
||||
|
||||
/**
|
||||
* Build NDEF message.
|
||||
*
|
||||
* @param[in,out] a buffer builder in which to create the NDEF message.
|
||||
* @param[in,out] buffer_builder a buffer builder in which to create the NDEF message.
|
||||
* The backing buffer is guaranteed to be continuous.
|
||||
*/
|
||||
void build_ndef_message(ac_buffer_builder_t &buffer_builder);
|
||||
|
|
|
@ -61,7 +61,7 @@ public:
|
|||
/**
|
||||
* Set the delegate that will receive events generated by the initiator.
|
||||
*
|
||||
* @oaram[in] delegate the delegate instance to use
|
||||
* @param[in] delegate the delegate instance to use
|
||||
*/
|
||||
void set_delegate(Delegate *delegate);
|
||||
|
||||
|
|
Loading…
Reference in New Issue