NFC: Fix doxygen documentation.

pull/7822/head
Vincent Coubard 2018-08-27 18:52:45 +01:00 committed by Donatien Garnier
parent 8e8ce973c6
commit d144d8bc78
9 changed files with 31 additions and 19 deletions

View File

@ -47,7 +47,6 @@ public:
* Create a NFCRemoteInitiator. * Create a NFCRemoteInitiator.
* @param[in] controller the NFCController instance that detected this endpoint * @param[in] controller the NFCController instance that detected this endpoint
* @param[in] buffer a bytes array used to store NDEF messages * @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<uint8_t> &buffer); NFCRemoteInitiator(NFCController *controller, const Span<uint8_t> &buffer);
virtual ~NFCRemoteInitiator(); virtual ~NFCRemoteInitiator();

View File

@ -48,7 +48,6 @@ public:
* *
* @param[in] controller pointer to the NFCController instance that created this object * @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 a bytes array used to store NDEF messages
* @param[in] buffer_size the array size in bytes
*/ */
Type4RemoteInitiator(NFCController *controller, const Span<uint8_t> &buffer); Type4RemoteInitiator(NFCController *controller, const Span<uint8_t> &buffer);

View File

@ -102,7 +102,7 @@ public:
/** /**
* Invoked when a record has been parsed. * 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) { } virtual void on_record_parsed(const Record &record) { }

View File

@ -50,42 +50,45 @@ struct Header {
* value. * value.
*/ */
struct RecordType { struct RecordType {
/**
* Type name format of a record.
*/
enum tnf_t { enum tnf_t {
/** /**
* empty type; value must be empty. * empty type; value must be empty.
*/ */
empty = 0x00, empty = 0x00, //!< empty
/** /**
* Type defined by the NFC forum; value must be defined. * 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. * Mime type; value must be defined.
*/ */
media_type = 0x02, media_type = 0x02, //!< media_type
/** /**
* Absolute URI; value must be defined. * Absolute URI; value must be defined.
*/ */
absolute_uri = 0x03, absolute_uri = 0x03, //!< absolute_uri
/** /**
* Type defined by vendors; value must be defined. * Type defined by vendors; value must be defined.
*/ */
external_type = 0x04, external_type = 0x04, //!< external_type
/** /**
* Unknown type; value must be empty. * Unknown type; value must be empty.
*/ */
unknown = 0x05, unknown = 0x05, //!< unknown
/** /**
* Use for middle and terminating chunk record. * Use for middle and terminating chunk record.
* value must be empty. * value must be empty.
*/ */
unchanged = 0x06 unchanged = 0x06 //!< unchanged
}; };
/** /**

View File

@ -78,9 +78,11 @@ struct GenericRecordParser : public RecordParser {
struct Delegate { struct Delegate {
/** /**
* Called when a record has been parsed and converted into a value_type. * 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: protected:
~Delegate() { } ~Delegate() { }
@ -107,8 +109,9 @@ struct GenericRecordParser : public RecordParser {
} }
/** /**
* Set the handler that processes record parser. * Set the delegate that processes record parser.
* @param handler *
* @param delegate The delegate to set.
*/ */
void set_delegate(Delegate *delegate) void set_delegate(Delegate *delegate)
{ {

View File

@ -70,8 +70,10 @@ public:
~Mime(); ~Mime();
/** /**
* Copy asign a Mime object. * Copy assign a Mime object.
* @param to_copy The Mime object to copy. *
* @param other The Mime object to copy.
*
* @return a reference to this object * @return a reference to this object
*/ */
Mime &operator=(const Mime &other); Mime &operator=(const Mime &other);

View File

@ -63,25 +63,31 @@ public:
/** /**
* Invoked when a text element has been parsed. * Invoked when a text element has been parsed.
*
* @param text The text 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) { } virtual void on_text_parsed(const Text &text, const RecordID &id) { }
/** /**
* Invoked when a text element has been parsed. * 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) { } virtual void on_uri_parsed(const URI &uri, const RecordID &id) { }
/** /**
* Invoked when a mime element has been parsed. * Invoked when a mime element has been parsed.
*
* @param mime The mime object 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) { } virtual void on_mime_parsed(const Mime &mime, const RecordID &id) { }
/** /**
* Invoked when an unknown record has been parsed. * 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) { } virtual void on_unknown_record_parsed(const Record &record) { }

View File

@ -89,6 +89,7 @@ public:
/** /**
* Copy a text from an external buffer. * 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 language_code The language code of the text.
* @param text The text to copy. * @param text The text to copy.
* *

View File

@ -92,7 +92,6 @@ public:
* *
* @param id The code of the URI prefix. * @param id The code of the URI prefix.
* @param uri_field The URI itself. * @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 * @note To remove the NULL terminator of the C-string of the uri_field
* parameter, you can use the utility function span_from_cstr. * parameter, you can use the utility function span_from_cstr.