Skip to content

Commit b46dba3

Browse files
authored
executor.h: Fix a few docs typos (#338)
Signed-off-by: Phaedrus Leeds <[email protected]>
1 parent 3b4ff9e commit b46dba3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

rclc/include/rclc/executor.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ rclc_executor_get_zero_initialized_executor(void);
130130
* Uses Atomics | No
131131
* Lock-Free | Yes
132132
*
133-
* \param[inout] e preallocated rclc_executor_t
133+
* \param[inout] executor preallocated rclc_executor_t
134134
* \param[in] context RCL context
135135
* \param[in] number_of_handles is the total number of subscriptions, timers, services,
136136
* clients and guard conditions. Do not include the number of nodes and publishers.
@@ -401,7 +401,7 @@ rclc_executor_add_service(
401401
rclc_service_callback_t callback);
402402

403403
/**
404-
* Adds a action client to an executor.
404+
* Adds an action client to an executor.
405405
* An error is returned if {@link rclc_executor_t.handles} array is full.
406406
* The total number_of_action_clients field of {@link rclc_executor_t.info}
407407
* is incremented by one.
@@ -442,7 +442,7 @@ rclc_executor_add_action_client(
442442
void * context);
443443

444444
/**
445-
* Adds a action server to an executor.
445+
* Adds an action server to an executor.
446446
* * An error is returned if {@link rclc_executor_t.handles} array is full.
447447
* * The total number_of_action_servers field of {@link rclc_executor_t.info}
448448
* is incremented by one.
@@ -738,7 +738,7 @@ rclc_executor_prepare(
738738
rclc_executor_t * executor);
739739

740740
/**
741-
* The spin-some function checks one-time for new data from the DDS-queue.
741+
* The spin_some function checks one-time for new data from the DDS-queue.
742742
* * the timeout is defined in {@link rclc_executor_t.timeout_ns} and can
743743
* be set by calling {@link rclc_executor_set_timeout()} function (default value is 100ms)
744744
*
@@ -775,7 +775,7 @@ rclc_executor_spin_some(
775775

776776
/**
777777
* The spin function checks for new data at DDS queue as long as ros context is available.
778-
* It calls {@link rclc_executor_spin_some()} as long as rcl_is_context_is_valid() returns true.
778+
* It calls {@link rclc_executor_spin_some()} as long as rcl_context_is_valid() returns true.
779779
*
780780
* Memory is dynamically allocated within rcl-layer, when DDS queue is accessed with rcl_wait_set_init()
781781
* (in spin_some function)
@@ -801,7 +801,7 @@ rclc_executor_spin(rclc_executor_t * executor);
801801
/**
802802
* The spin_period function checks for new data at DDS queue as long as ros context is available.
803803
* It is called every period nanoseconds.
804-
* It calls {@link rclc_executor_spin_some()} as long as rcl_is_context_is_valid() returns true.
804+
* It calls {@link rclc_executor_spin_some()} as long as rcl_context_is_valid() returns true.
805805
*
806806
* Memory is dynamically allocated within rcl-layer, when DDS queue is accessed with rcl_wait_set_init()
807807
* (in spin_some function)

0 commit comments

Comments
 (0)