diff --git a/features/nfc/nfc/NFCRemoteInitiator.h b/features/nfc/nfc/NFCRemoteInitiator.h index aea21f57e6..0ceeccd1e6 100644 --- a/features/nfc/nfc/NFCRemoteInitiator.h +++ b/features/nfc/nfc/NFCRemoteInitiator.h @@ -47,7 +47,6 @@ public: * Create a NFCRemoteInitiator. * @param[in] controller the NFCController instance that detected this endpoint * @param[in] buffer a bytes array used to store NDEF messages - * @param[in] buffer_size the array size in bytes */ NFCRemoteInitiator(NFCController *controller, const Span &buffer); virtual ~NFCRemoteInitiator(); diff --git a/features/nfc/nfc/Type4RemoteInitiator.h b/features/nfc/nfc/Type4RemoteInitiator.h index 32fc0aa583..5e7ef45d1a 100644 --- a/features/nfc/nfc/Type4RemoteInitiator.h +++ b/features/nfc/nfc/Type4RemoteInitiator.h @@ -48,7 +48,6 @@ public: * * @param[in] controller pointer to the NFCController instance that created this object * @param[in] buffer a bytes array used to store NDEF messages - * @param[in] buffer_size the array size in bytes */ Type4RemoteInitiator(NFCController *controller, const Span &buffer); diff --git a/features/nfc/nfc/ndef/MessageParser.h b/features/nfc/nfc/ndef/MessageParser.h index 41a22bff4f..41c4a9e3a3 100644 --- a/features/nfc/nfc/ndef/MessageParser.h +++ b/features/nfc/nfc/ndef/MessageParser.h @@ -102,7 +102,7 @@ public: /** * Invoked when a record has been parsed. * - * @param The record obtained from parsing. + * @param record The record obtained from parsing. */ virtual void on_record_parsed(const Record &record) { } diff --git a/features/nfc/nfc/ndef/Record.h b/features/nfc/nfc/ndef/Record.h index 80afd69a44..7c6fcd2ec9 100644 --- a/features/nfc/nfc/ndef/Record.h +++ b/features/nfc/nfc/ndef/Record.h @@ -50,42 +50,45 @@ struct Header { * value. */ struct RecordType { + /** + * Type name format of a record. + */ enum tnf_t { /** * empty type; value must be empty. */ - empty = 0x00, + empty = 0x00, //!< empty /** * Type defined by the NFC forum; value must be defined. */ - well_known_type = 0x01, + well_known_type = 0x01,//!< well_known_type /** * Mime type; value must be defined. */ - media_type = 0x02, + media_type = 0x02, //!< media_type /** * Absolute URI; value must be defined. */ - absolute_uri = 0x03, + absolute_uri = 0x03, //!< absolute_uri /** * Type defined by vendors; value must be defined. */ - external_type = 0x04, + external_type = 0x04, //!< external_type /** * Unknown type; value must be empty. */ - unknown = 0x05, + unknown = 0x05, //!< unknown /** * Use for middle and terminating chunk record. * value must be empty. */ - unchanged = 0x06 + unchanged = 0x06 //!< unchanged }; /** diff --git a/features/nfc/nfc/ndef/RecordParser.h b/features/nfc/nfc/ndef/RecordParser.h index 65ccb3d2fa..4c09078095 100644 --- a/features/nfc/nfc/ndef/RecordParser.h +++ b/features/nfc/nfc/ndef/RecordParser.h @@ -78,9 +78,11 @@ struct GenericRecordParser : public RecordParser { struct Delegate { /** * Called when a record has been parsed and converted into a value_type. - * @param record The record in its parsed form. + * + * @param object_parsed The record in its parsed form. + * @param id The RecordId associated with the object parsed. */ - virtual void on_record_parsed(const ParsingResult &record, const RecordID &id) = 0; + virtual void on_record_parsed(const ParsingResult &object_parsed, const RecordID &id) = 0; protected: ~Delegate() { } @@ -107,8 +109,9 @@ struct GenericRecordParser : public RecordParser { } /** - * Set the handler that processes record parser. - * @param handler + * Set the delegate that processes record parser. + * + * @param delegate The delegate to set. */ void set_delegate(Delegate *delegate) { diff --git a/features/nfc/nfc/ndef/common/Mime.h b/features/nfc/nfc/ndef/common/Mime.h index d84ef858bb..37e47ee7d7 100644 --- a/features/nfc/nfc/ndef/common/Mime.h +++ b/features/nfc/nfc/ndef/common/Mime.h @@ -70,8 +70,10 @@ public: ~Mime(); /** - * Copy asign a Mime object. - * @param to_copy The Mime object to copy. + * Copy assign a Mime object. + * + * @param other The Mime object to copy. + * * @return a reference to this object */ Mime &operator=(const Mime &other); diff --git a/features/nfc/nfc/ndef/common/SimpleMessageParser.h b/features/nfc/nfc/ndef/common/SimpleMessageParser.h index e9fea51a52..a4da0049f9 100644 --- a/features/nfc/nfc/ndef/common/SimpleMessageParser.h +++ b/features/nfc/nfc/ndef/common/SimpleMessageParser.h @@ -63,25 +63,31 @@ public: /** * Invoked when a text element has been parsed. + * * @param text The text parsed. + * @param id The RecordId of the text object. */ virtual void on_text_parsed(const Text &text, const RecordID &id) { } /** * Invoked when a text element has been parsed. - * @param text The text parsed. + * + * @param uri The uri parsed. + * @param id The RecordId of the uri object. */ virtual void on_uri_parsed(const URI &uri, const RecordID &id) { } /** * Invoked when a mime element has been parsed. + * * @param mime The mime object parsed. + * @param id The RecordId of the mime object. */ virtual void on_mime_parsed(const Mime &mime, const RecordID &id) { } /** * Invoked when an unknown record has been parsed. - * @param The record freshly parsed. + * @param record The record freshly parsed. */ virtual void on_unknown_record_parsed(const Record &record) { } diff --git a/features/nfc/nfc/ndef/common/Text.h b/features/nfc/nfc/ndef/common/Text.h index 14853fc52a..aa6421eef8 100644 --- a/features/nfc/nfc/ndef/common/Text.h +++ b/features/nfc/nfc/ndef/common/Text.h @@ -89,6 +89,7 @@ public: /** * Copy a text from an external buffer. * + * @param text_encoding The encoding of the text. * @param language_code The language code of the text. * @param text The text to copy. * diff --git a/features/nfc/nfc/ndef/common/URI.h b/features/nfc/nfc/ndef/common/URI.h index 3f4e5d3f78..73d4f64119 100644 --- a/features/nfc/nfc/ndef/common/URI.h +++ b/features/nfc/nfc/ndef/common/URI.h @@ -92,7 +92,6 @@ public: * * @param id The code of the URI prefix. * @param uri_field The URI itself. - * @param uri_field_size The size of the URI. * * @note To remove the NULL terminator of the C-string of the uri_field * parameter, you can use the utility function span_from_cstr.