Add comment to am_ringbuf_ctor()

adel-mamin · adel-mamin · commit 326ef218fc54 · 2025-08-02T10:58:21.000+03:00
diff --git a/libs/ringbuf/ringbuf.h b/libs/ringbuf/ringbuf.h
@@ -64,6 +64,8 @@ extern "C" {
 /**
  * Construct ring buffer.
  *
+ * Must be called before calling any other ring buffer API.
+ *
  * @param rb        the ring buffer
  * @param buf       the ring buffer's memory
  * @param buf_size  the ring buffer's memory size [bytes]

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@ extern "C" {`
`64`	`64`	`/**`
`65`	`65`	`* Construct ring buffer.`
`66`	`66`	`*`
	`67`	`+ * Must be called before calling any other ring buffer API.`
	`68`	`+ *`
`67`	`69`	`* @param rb the ring buffer`
`68`	`70`	`* @param buf the ring buffer's memory`
`69`	`71`	`* @param buf_size the ring buffer's memory size [bytes]`