mem: Improve documentation.

lorinder · lorinder · commit 4932e8d538ac · 2025-07-31T17:20:43.000-05:00
diff --git a/src/csnip/mem.h b/src/csnip/mem.h
@@ -72,7 +72,10 @@ void csnip_mem_aligned_free(void* mem);
  *
  *	@param	ptr
  *		The lvalue to assign to.  This must be a pointer type,
- *		and the per-object size allocated is sizeof(*ptr).
+ *		and the per-object size allocated is sizeof(*ptr).  If
+ *		the allocation fails, a NULL value will be written into
+ *		the, in addition to the error being returned or
+ *		processed according to the err argument.
  *
  *	@param	err
  *		Error return; accepts the special _ and error_ignore

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,10 @@ void csnip_mem_aligned_free(void* mem);`
`72`	`72`	`*`
`73`	`73`	`* @param ptr`
`74`	`74`	`* The lvalue to assign to. This must be a pointer type,`
`75`		`- * and the per-object size allocated is sizeof(*ptr).`
	`75`	`+ * and the per-object size allocated is sizeof(*ptr). If`
	`76`	`+ * the allocation fails, a NULL value will be written into`
	`77`	`+ * the, in addition to the error being returned or`
	`78`	`+ * processed according to the err argument.`
`76`	`79`	`*`
`77`	`80`	`* @param err`
`78`	`81`	`* Error return; accepts the special _ and error_ignore`