Skip to content

Commit 0f3adf2

Browse files
committed
extend description of pntrTempAllocStack
1 parent bc48424 commit 0f3adf2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/mmdata.c

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2468,8 +2468,11 @@ long g_pntrStartTempAllocStack = 0; /* Where to start freeing temporary alloca
24682468
* \brief a \ref stack "stack" of \ref temp_pntrString.
24692469
*
24702470
* Holds pointers to temporarily allocated data of type \ref temp_pntrString. Such
2471-
* a \ref stack "stack" contains strictly __local__ data of a function, not
2472-
* accessed from outer levels.
2471+
* a \ref stack "stack" is primarily designed to function like a stack for
2472+
* temporary allocated ad hoc operands, as described in \ref stack. The stack top
2473+
* index is \ref g_pntrTempAllocStackTop, always refering to the next push
2474+
* position. The \ref g_pntrStartTempAllocStack supports nested operations by
2475+
* indicating where the operands for the upcoming operation start from.
24732476
* \bug The element type should be temp_pntrString, because a NULL_PNTRSTRING
24742477
* must not be pushed on the stack.
24752478
*/

0 commit comments

Comments
 (0)