fix description of memUsedPool

wlammen · wlammen · commit ac1dc027d378 · 2022-03-04T20:27:50.000+01:00
diff --git a/src/mmdata.c b/src/mmdata.c
@@ -232,6 +232,8 @@ long poolTotalFree = 0; /* Total amount of free space allocated in pool */
  * at the end of the array are unused.  Its current usage is given by
  * \ref memUsedPoolSize.  Its capacity is given by \ref memUsedPoolMax.
  *
+ * \attention The pool may contain full \ref block "blocks".
+ *
  * \invariant Each block in the used blocks array has its index noted in its
  * hidden header, for backward reference.
  *

Original file line number	Diff line number	Diff line change
`@@ -232,6 +232,8 @@ long poolTotalFree = 0; /* Total amount of free space allocated in pool */`
`232`	`232`	`* at the end of the array are unused. Its current usage is given by`
`233`	`233`	`* \ref memUsedPoolSize. Its capacity is given by \ref memUsedPoolMax.`
`234`	`234`	`*`
	`235`	`+ * \attention The pool may contain full \ref block "blocks".`
	`236`	`+ *`
`235`	`237`	`* \invariant Each block in the used blocks array has its index noted in its`
`236`	`238`	`* hidden header, for backward reference.`
`237`	`239`	`*`