Docs: Clarification of CONTAINER_OF

pearson · nashif · commit a6f8fc326cb7 · 2021-10-28T10:19:39.000-04:00
This is a small reordering of the CONTAINER_OF description to
clarify its purpose.

Signed-off-by: Chris Pearson &lt;ctpearson@gmail.com&gt;
diff --git a/include/sys/util.h b/include/sys/util.h
@@ -124,7 +124,7 @@ extern "C" {
 	((ptr) && ((ptr) >= &array[0] && (ptr) < &array[ARRAY_SIZE(array)]))
 
 /**
- * @brief Get a pointer to a container structure from an element
+ * @brief Get a pointer to a structure containing the element
  *
  * Example:
  *

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ extern "C" {`
`124`	`124`	`((ptr) && ((ptr) >= &array[0] && (ptr) < &array[ARRAY_SIZE(array)]))`
`125`	`125`
`126`	`126`	`/**`
`127`		`- * @brief Get a pointer to a container structure from an element`
	`127`	`+ * @brief Get a pointer to a structure containing the element`
`128`	`128`	`*`
`129`	`129`	`* Example:`
`130`	`130`	`*`