Skip to content

Commit 593777c

Browse files
authored
Clarify wording for waitParams and signalParams (#421)
Improve descriptions for array vs vector and ranges. Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
1 parent 94a5bbd commit 593777c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

scripts/core/externalSemaphores.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,11 +192,11 @@ params:
192192
- type: "$x_external_semaphore_ext_handle_t*"
193193
name: "phSemaphores"
194194
desc: |
195-
[in][range(0, numSemaphores)] The vector of external semaphore handles to be appended into command list.
195+
[in][range(0, numSemaphores)] The array of pointers to external semaphore handles to be appended into command list.
196196
- type: "$x_external_semaphore_signal_params_ext_t*"
197197
name: "signalParams"
198198
desc: |
199-
[in] Signal parameters.
199+
[in][range(0, numSemaphores)] The array of pointers to external semepahore signal parameters.
200200
- type: $x_event_handle_t
201201
name: hSignalEvent
202202
desc: "[in][optional] handle of the event to signal on completion"
@@ -237,11 +237,11 @@ params:
237237
- type: "$x_external_semaphore_ext_handle_t*"
238238
name: "phSemaphores"
239239
desc: |
240-
[in] [range(0,numSemaphores)] The vector of external semaphore handles to append into command list.
240+
[in][range(0,numSemaphores)] The array of pointers to external semaphore handles to append into command list.
241241
- type: "$x_external_semaphore_wait_params_ext_t*"
242242
name: "waitParams"
243243
desc: |
244-
[in] Wait parameters.
244+
[in][range(0,numSemaphores)] The array of pointers to external semepahore wait parameters.
245245
- type: $x_event_handle_t
246246
name: hSignalEvent
247247
desc: "[in][optional] handle of the event to signal on completion"

0 commit comments

Comments
 (0)