Skip to content

Commit 5365dda

Browse files
authored
chore: fix typos (#229)
1 parent c306068 commit 5365dda

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

ecsact/runtime/async.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ ECSACT_ASYNC_API_FN(void, ecsact_async_flush_events)
164164
* underlying async runtime. This may be a hostname/ip address + port or
165165
* some other string deinfed by the implementation. Please review
166166
* documentation for your ecsact async api provider. May be NULL to
167-
* indiciate wanting to connect to the 'default' if available.
167+
* indicate wanting to connect to the 'default' if available.
168168
* @returns a request ID representing this async request. Later used in @ref
169169
* ecsact_async_error_callback if an error occurs
170170
*/

ecsact/runtime/common.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,13 @@ typedef enum {
159159
ECSACT_ADD_OK = 0,
160160

161161
/**
162-
* An invalid or non-existant entity ID was found in one or more of the
162+
* An invalid or non-existent entity ID was found in one or more of the
163163
* component fields.
164164
*/
165165
ECSACT_ADD_ERR_ENTITY_INVALID = 1,
166166

167167
/**
168-
* One or more of the component entity fields constraints were not satisifed.
168+
* One or more of the component entity fields constraints were not satisfied.
169169
*/
170170
ECSACT_ADD_ERR_ENTITY_CONSTRAINT_BROKEN = 2,
171171
} ecsact_add_error;
@@ -177,13 +177,13 @@ typedef enum {
177177
ECSACT_UPDATE_OK = 0,
178178

179179
/**
180-
* An invalid or non-existant entity ID was found in one or more of the
180+
* An invalid or non-existent entity ID was found in one or more of the
181181
* component fields.
182182
*/
183183
ECSACT_UPDATE_ERR_ENTITY_INVALID = 1,
184184

185185
/**
186-
* One or more of the component entity fields constraints were not satisifed.
186+
* One or more of the component entity fields constraints were not satisfied.
187187
*/
188188
ECSACT_UPDATE_ERR_ENTITY_CONSTRAINT_BROKEN = 2,
189189
} ecsact_update_error;
@@ -195,13 +195,13 @@ typedef enum {
195195
ECSACT_EXEC_SYS_OK = 0,
196196

197197
/**
198-
* An invalid or non-existant entity ID was found in one or more of the
198+
* An invalid or non-existent entity ID was found in one or more of the
199199
* action fields.
200200
*/
201201
ECSACT_EXEC_SYS_ERR_ACTION_ENTITY_INVALID = 1,
202202

203203
/**
204-
* One or more of the action entity fields constraints were not satisifed.
204+
* One or more of the action entity fields constraints were not satisfied.
205205
*/
206206
ECSACT_EXEC_SYS_ERR_ACTION_ENTITY_CONSTRAINT_BROKEN = 2,
207207
} ecsact_execute_systems_error;
@@ -249,7 +249,7 @@ typedef enum {
249249

250250
/**
251251
* System may only execute on entities where this component is present, but
252-
* the systme may not read or write to the component.
252+
* the system may not read or write to the component.
253253
*/
254254
ECSACT_SYS_CAP_INCLUDE = 8,
255255

@@ -326,8 +326,8 @@ typedef enum {
326326
/**
327327
* ees - Entity Execution Status
328328
*
329-
* An entitys execution status gives details about how an entity relates to a
330-
* system or action's execution. By default an entitys execution status is
329+
* An entities execution status gives details about how an entity relates to a
330+
* system or action's execution. By default an entities execution status is
331331
* `ECSACT_ESS_IDLE`.
332332
*
333333
* @note This detail is exposed mostly for serialization. It is important to

ecsact/runtime/core.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ ECSACT_CORE_API_FN(void, ecsact_destroy_entity)
9494
);
9595

9696
/**
97-
* Count number of entites in registry
97+
* Count number of entities in registry
9898
*/
9999
ECSACT_CORE_API_FN(int, ecsact_count_entities)
100100
( //
@@ -215,8 +215,8 @@ ECSACT_CORE_API_FN(void, ecsact_remove_component)
215215
* against all registered components. System implementations may run in parallel
216216
* on multiple threads.
217217
* @param execution_count how many times the systems list should execute
218-
* @param execution_options_list (optional) Seqential list of execution options.
219-
* If set (not NULL), list length is determined by `execution_count`.
218+
* @param execution_options_list (optional) Sequential list of execution
219+
* options. If set (not NULL), list length is determined by `execution_count`.
220220
* @param events_collector (optional) Pointer to events collector. If set,
221221
* events will be recorded and the callbacks on the collector will be
222222
* invoked. Invocations occur on the calling thread.

ecsact/runtime/dynamic.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ ECSACT_DYNAMIC_API_FN(bool, ecsact_system_execution_context_has)
117117
* Generate a new entity with specified components.
118118
*
119119
* @param component_count length of `component_ids` and `components_data`
120-
* @param component_ids list of component ids associatd with `components_data`.
120+
* @param component_ids list of component ids associated with `components_data`.
121121
* @param components_data list of component data associated with
122122
* `component_ids`.
123123
*
@@ -133,7 +133,7 @@ ECSACT_DYNAMIC_API_FN(void, ecsact_system_execution_context_generate)
133133
);
134134

135135
/**
136-
* Get the parent system exeuction context.
136+
* Get the parent system execution context.
137137
*
138138
* Only available if the currently executing system is a nested system.
139139
*/

ecsact/runtime/serialize.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@
2424
#endif // ECSACT_SERIALIZE_API_FN
2525

2626
/**
27-
* Get the amount of bytes an action with id `action_id` requies to serialize.
27+
* Get the amount of bytes an action with id `action_id` requires to serialize.
2828
*/
2929
ECSACT_SERIALIZE_API_FN(int, ecsact_serialize_action_size)
3030
( //
3131
ecsact_action_id action_id
3232
);
3333

3434
/**
35-
* Get the amount of bytes a component with id `component_id` requies to
35+
* Get the amount of bytes a component with id `component_id` requires to
3636
* serialize.
3737
*/
3838
ECSACT_SERIALIZE_API_FN(int, ecsact_serialize_component_size)
@@ -42,7 +42,7 @@ ECSACT_SERIALIZE_API_FN(int, ecsact_serialize_component_size)
4242

4343
/**
4444
* Serialize action into implementation defined format suitable for sending over
45-
* a socket and/or written to a file. Guranteed to be deserializable across
45+
* a socket and/or written to a file. Guaranteed to be deserializable across
4646
* platforms.
4747
*
4848
* @param action_id Valid action ID associated with `action_data`

0 commit comments

Comments
 (0)