Skip to content

Commit

Permalink
iox-eclipse-iceoryx#2251 Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
elBoberido committed Apr 14, 2024
1 parent 55b4b58 commit bc98a7f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/aspice_swe3_4/swe_docu_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ In iceoryx are also custom tags used for extended documentation like errors.

### Include Additional Header Into Documentation

In some cases, the implementation of a component is is placed in an internal folder and the header in the public folder acts as a trampoline with some using declarations.
In some cases, the implementation of a component is placed in an internal folder, and the header in the public folder acts as a trampoline, with some using declarations.
The iceoryx endpoints like `Publisher`, `Subscriber`, etc. are such examples where the public header only includes a using declaration to the actual implementation.
In order to include the documentation of these components, the header containing the documentation can be added to the `INCLUDE_DIR_AND_ADDITIONAL_FILES` list in the CMakeLists.txt.

Expand Down
4 changes: 2 additions & 2 deletions iceoryx_examples/callbacks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@ void heartbeatCallback(iox::popo::UserTrigger*)
}
```
The `onSampleReceivedCallback` is more complex. We first acquires all the received
samples and checks which subscriber signaled the event by acquiring the subscriber's
The `onSampleReceivedCallback` is more complex. We first acquire all the received
samples and check which subscriber signaled the event by acquiring the subscriber's
service description. If the instance is equal to `FrontLeft` we store the sample
in the `leftCache` otherwise in the `rightCache`.
Expand Down

0 comments on commit bc98a7f

Please sign in to comment.