Skip to content

Commit a7f31ad

Browse files
committed
Cosmetic wording updates and typo fixes in tutorial2 README.
1 parent c8195ef commit a7f31ad

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

tutorials/tutorial2/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2502,7 +2502,7 @@ Note, that [comms::Message](https://commschamp.github.io/comms_doc/classcomms_1_
25022502
implementation of virtual `refreshImpl()` which constantly return false.
25032503

25042504
The [comms::MessageBase](https://commschamp.github.io/comms_doc/classcomms_1_1MessageBase.html) is expected
2505-
to implement **non-virtual** `doRefresh()` member function, which calls `refresh()` of every contained field.
2505+
to implement **non-virtual** `doRefresh()` member function, which calls `refresh()` of every contained field
25062506
and override **virtual** `refreshImpl()` when polymorphic refresh functionality is requested by the interface:
25072507
```cpp
25082508
class comms::MessageBase<...>
@@ -2598,7 +2598,7 @@ The message definition above has the following logic for having `F3` field being
25982598
```
25992599
Please note the following aspects:
26002600

2601-
- The `<` and `>` comparisons cannot be used "as-is" in XML attributes / values. They need to be replaced with `&lt;` and `&gt;` respectively.
2601+
- The `<` and `>` symbols cannot be used "as-is" in XML attributes / values. They need to be replaced with `&lt;` and `&gt;` respectively.
26022602
- The wrapped field definition needs to be wrapped in `<field>` XML node when there are other nodes present (like `<or>` in
26032603
the example above).
26042604
- The logical **or** is represented by the `<or>` XML node while logical **and** is represented by the `<and>` XML
@@ -2626,7 +2626,7 @@ void ClientSession::sendMsg14()
26262626
}
26272627
```
26282628

2629-
Also since **v6.1** of the [CommsDSL](https://github.com/commschamp/CommsDSL-Specification)
2629+
Since **v6.1** of the [CommsDSL](https://github.com/commschamp/CommsDSL-Specification)
26302630
specification it is allowed to check the size of the sequence fields like `<string>`, `<data>`,
26312631
or `<list>` int the `<optional>` field conditions. To do so there is a need to use `#` character
26322632
after the sibling field reference prefix `$`.
@@ -2716,7 +2716,7 @@ The replacing of the member fields became available since **v5.0** of the
27162716
- Reusing definition of one message to define another is possible using **copyFieldsFrom**
27172717
property. The same property can be used to copy member fields from the definition of
27182718
the [&lt;bundle&gt;](#bundle-fields) field.
2719-
- Reusing other fields definitions is possuble using **reuse** property.
2719+
- Reusing other fields definitions is possible using **reuse** property.
27202720
- The replacing of member fields in composite fields like `<bundle>` and `<bitfield>`
27212721
is available since version **v5.0** of the **CommsDSL** using `<replace>` child node.
27222722
- The fields are abstractions around actual value storage to provide common
@@ -2725,15 +2725,15 @@ The replacing of the member fields became available since **v5.0** of the
27252725
is **value()**. It is used to access the value storage **by-reference**.
27262726
- Every field has inner `ValueType` type, which defines type of the inner value storage.
27272727
- `ValueType` of [&lt;enum&gt;](#enum-fields) is a relevant C++ enum class.
2728-
- `ValueType` of [&lt;int&gt;](#int-fields) is an appropriate integral type (`std::int8_t`,
2728+
- `ValueType` of [&lt;int&gt;](#int-fields) is an appropriate integral type (`std::int8_t`,
27292729
`std::uint8_t`, etc ...)
2730-
- `ValueType` of [&lt;set&gt;](#set-fields) is an appropriate **unsigned** integral type
2730+
- `ValueType` of [&lt;set&gt;](#set-fields) is an appropriate **unsigned** integral type
27312731
(`std::uint8_t`, `std::uint16_t`, etc...).
27322732
- `ValueType` of [&lt;float&gt;](#float-fields) is an appropriate floating point type (`float` or
27332733
`double`).
27342734
- **Default** `ValueType` of [&lt;string&gt;](#string-fields) is `std::string`, but it can be changed
27352735
to better suit the application's needs.
2736-
- **Default** `ValueType` of [&lt;data&gt;](#data-fields) is `std::vector&lt;std::uint8_t&gt;`, but it
2736+
- **Default** `ValueType` of [&lt;data&gt;](#data-fields) is `std::vector<std::uint8_t>`, but it
27372737
can be changed to better suit the application's needs.
27382738
- `ValueType` of [&lt;bundle&gt;](#bundle-fields) is `std::tuple` of all its member fields.
27392739
- `ValueType` of [&lt;bitfield&gt;](#bitfield-fields) is `std::tuple` of all its member fields.

0 commit comments

Comments
 (0)