Skip to content

Commit ca5f09a

Browse files
Amanda ButlerDonatien Garnier
authored andcommitted
Copy edit NDEF.md
Fix minor grammar nits.
1 parent c1e5624 commit ca5f09a

File tree

1 file changed

+5
-5
lines changed
  • docs/reference/api/connectivity/nfc

1 file changed

+5
-5
lines changed

docs/reference/api/connectivity/nfc/NDEF.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
### NDEF API
22

3-
We provide API to construct and parse NDEF messages which is the common data format exchange for NFC messages.
3+
Mbed OS provide this API to construct and parse NDEF messages, which is the common data format exchange for NFC messages.
44

5-
A NDEF message is a collection of separate NDEF records where each of these records is defined by a type such as URI, Mime, Text that identifies what is contained in the record and a payload.
5+
An NDEF message is a collection of separate NDEF records. Each of these records is defined by a type, such as URI, Mime and Text, that identifies a payload and what the record contains.
66

77
#### Parsing
88

9-
The class `mbed::nfc::ndef::MessageParser` parses a buffer of data in input and produces parsing events that are forwarded to its delegate. To help developers we offer a more integrated parser (`mbed::nfc::ndef::common::SimpleMessageParser`) that parses well known NFC types records such as Text, URI or Mime records and produces usable objects out of the box.
9+
The class `mbed::nfc::ndef::MessageParser` parses a buffer of data in input and produces parsing events that are forwarded to its delegate. To help you, we offer a more integrated parser (`mbed::nfc::ndef::common::SimpleMessageParser`) that parses well known NFC types records, such as Text, URI or Mime records, and produces usable objects out of the box.
1010

1111
```
1212
#include "nfc/ndef/common/SimpleMessageParser.h"
@@ -81,7 +81,7 @@ An application can extend capabilities of `SimpleMessageParser` by adding new re
8181

8282
#### Construction
8383

84-
The class `mbed::nfc::ndef::MessageBuilder` builds a NDEF message into a user provided buffer. `URI`, `Text` and `Mime` type can be serialized in the builder with the help of the member function `append_as_record`.
84+
The class `mbed::nfc::ndef::MessageBuilder` builds an NDEF message into a user-provided buffer. `URI`, `Text` and `Mime` types can be serialized in the builder with the help of the member function `append_as_record`.
8585

8686
```
8787
#include "nfc/ndef/MessageBuilder.h"
@@ -103,4 +103,4 @@ size_t build_ndef_message(const Span<uint8_t> &buffer) {
103103
}
104104
```
105105

106-
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/FIXME)
106+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/FIXME)

0 commit comments

Comments
 (0)