Skip to content

Commit

Permalink
Corrected documentation in let_executor.h
Browse files Browse the repository at this point in the history
Signed-off-by: Staschulat Jan <jan.staschulat@de.bosch.com>
  • Loading branch information
JanStaschulat committed Dec 10, 2019
1 parent 35d7e9c commit aef1176
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions rcl_executor/include/rcl_executor/let_executor.h
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,12 @@ rcle_let_executor_add_timer(
* * processes all handles in the order, how they were added to the executor with the respective add-functions
* by calling respective callback (thus implementing first-read, process, semantic of LET)
*
* Memory is dynamically allocated within rcl-layer, when DDS queue is accessed with rcl_wait_set_init()
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Allocates Memory | Yes
* Thread-Safe | No
* Uses Atomics | No
* Lock-Free | Yes
Expand All @@ -232,11 +233,13 @@ rcle_let_executor_spin_some(
* The spin function checks for new data at DDS queue as long as ros context is available.
* It calls {@link rcle_let_executor_spin_some()} as long as rcl_is_context_is_valid() returns true.
*
* Memory is dynamically allocated within rcl-layer, when DDS queue is accessed with rcl_wait_set_init()
* (in spin_some function)
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Allocates Memory | Yes
* Thread-Safe | No
* Uses Atomics | No
* Lock-Free | Yes
Expand All @@ -256,11 +259,12 @@ rcle_let_executor_spin(rcle_let_executor_t * executor);
* It is called every period nanoseconds.
* It calls {@link rcle_let_executor_spin_some()} as long as rcl_is_context_is_valid() returns true.
*
*
* Memory is dynamically allocated within rcl-layer, when DDS queue is accessed with rcl_wait_set_init()
* (in spin_some function)
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Allocates Memory | Yes
* Thread-Safe | No
* Uses Atomics | No
* Lock-Free | Yes
Expand Down

0 comments on commit aef1176

Please sign in to comment.