Skip to content

Commit 9ff80d4

Browse files
committed
Updating some of comms library doc links.
1 parent de3dc61 commit 9ff80d4

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

tutorials/tutorial13/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ starting from the first message having the same numeric ID. In other word the in
157157
158158
**SIDE NOTE**: The [comms::frame::MsgIdLayer](https://commschamp.github.io/comms_doc/classcomms_1_1protocol_1_1MsgIdLayer.html)
159159
used by the framing is capable of returning the detected index / offset information via special extra parameters
160-
(see [comms::frame::msgIndex()](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html)). These parameters
160+
(see [comms::frame::msgIndex()](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html)). These parameters
161161
are used by the processing functions from [comms/process.h](https://commschamp.github.io/comms_doc/process_8h.html) to
162162
get the numeric message ID and the index (offset) information in order to perform the message dispatch. Extracting this
163163
information is a bit out of scope for this tutorial and will be covered in other later one.

tutorials/tutorial18/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ std::size_t ServerSession::processInputImpl(const std::uint8_t* buf, std::size_t
5151
The [read()](https://commschamp.github.io/comms_doc/classcomms_1_1protocol_1_1ProtocolLayerBase.html)
5252
member function of every protocol layer receives a variadic `extraValues` last parameter, which can be
5353
used to add several output parameters to the function. In this example the
54-
[comms::frame::msgId()](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html) is used
54+
[comms::frame::msgId()](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html) is used
5555
to add `msgId` local variable as an output parameter for the message numeric ID. Also the
56-
[comms::frame::msgIndex()](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html)
56+
[comms::frame::msgIndex()](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html)
5757
is used to add `msgIdx` local variable as an output parameter for the index of the message (offset in
5858
the tuple of the input messages starting from the first message sharing the same ID).
5959
Later down the code both `msgId` and `msgIdx` values are used to dispatch message object into the
@@ -177,8 +177,8 @@ struct DataViewDefaultOptionsT : public TBase
177177
- The [COMMS Library](https://github.com/commschamp/comms) provides multiple ways to access
178178
some or all of the framing fields.
179179
- The `read()` member function can receive and update selected output parameters via
180-
[comms::frame::msgId()](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html),
181-
[comms::frame::msgIndex()](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html), etc...
180+
[comms::frame::msgId()](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html),
181+
[comms::frame::msgIndex()](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html), etc...
182182
- In order to get **all** the frame fields the
183183
[readFieldsCached()](https://commschamp.github.io/comms_doc/classcomms_1_1protocol_1_1ProtocolLayerBase.html)
184184
member function needs to be used.

tutorials/tutorial5/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,12 +412,12 @@ when the code is recompiled.
412412
- Every `<frame>` uses internal layers to specify transport fields and their
413413
roles.
414414
- The generated C++ code of the frame(s) resides in [include/&lt;namespace&gt;/frame](include/tutorial5/frame) folder and
415-
uses classes from [comms::frame](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html)
415+
uses classes from [comms::frame](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html)
416416
namespace to define the layers.
417417
- The defined framing layers wrap one another, as the result the outermost layer is used
418418
to handle the whole transport framing.
419419
- For available frame API reference open the documentation of the
420-
[outermost layer](https://commschamp.github.io/comms_doc/namespacecomms_1_1protocol.html) type.
420+
[outermost layer](https://commschamp.github.io/comms_doc/namespacecomms_1_1frame.html) type.
421421
- The polymorphic behavior of the common interface class may influence the ability of the
422422
frame to perform its `write()` operation.
423423
- When write operation returns [commms::ErrorStatus::UpdateRequired](https://commschamp.github.io/comms_doc/ErrorStatus_8h.html)

0 commit comments

Comments
 (0)