Add corrections to libs/event/event.h comments

adel-mamin · adel-mamin · commit 7d0e6f56e434 · 2025-04-21T19:29:16.000+03:00
diff --git a/libs/event/event.h b/libs/event/event.h
@@ -231,7 +231,7 @@ struct am_event *am_event_allocate_x(int id, int size, int margin);
  * The event is allocated from one of the memory pools provided
  * with am_event_add_pool() function.
  *
- * The function asserts if there is no memory left to accommodate the event.
+ * The function asserts, if there is no memory left to accommodate the event.
  *
  * Thread safe.
  *
@@ -243,7 +243,10 @@ struct am_event *am_event_allocate_x(int id, int size, int margin);
 struct am_event *am_event_allocate(int id, int size);
 
 /**
- * Try to free the event allocated earlier with am_event_allocate().
+ * Try to free the event.
+ *
+ * The event is either static or allocated earlier with
+ * am_event_allocate(), am_event_dup() or am_event_dup_x() API calls.
  *
  * Decrements event reference counter by one and frees the event,
  * if the reference counter drops to zero.

Original file line number	Diff line number	Diff line change
`@@ -231,7 +231,7 @@ struct am_event *am_event_allocate_x(int id, int size, int margin);`
`231`	`231`	`* The event is allocated from one of the memory pools provided`
`232`	`232`	`* with am_event_add_pool() function.`
`233`	`233`	`*`
`234`		`- * The function asserts if there is no memory left to accommodate the event.`
	`234`	`+ * The function asserts, if there is no memory left to accommodate the event.`
`235`	`235`	`*`
`236`	`236`	`* Thread safe.`
`237`	`237`	`*`
`@@ -243,7 +243,10 @@ struct am_event *am_event_allocate_x(int id, int size, int margin);`
`243`	`243`	`struct am_event *am_event_allocate(int id, int size);`
`244`	`244`
`245`	`245`	`/**`
`246`		`- * Try to free the event allocated earlier with am_event_allocate().`
	`246`	`+ * Try to free the event.`
	`247`	`+ *`
	`248`	`+ * The event is either static or allocated earlier with`
	`249`	`+ * am_event_allocate(), am_event_dup() or am_event_dup_x() API calls.`
`247`	`250`	`*`
`248`	`251`	`* Decrements event reference counter by one and frees the event,`
`249`	`252`	`* if the reference counter drops to zero.`