fix spelling errors

Author: wlammen

src/mmdata.c

@@ -2489,15 +2489,15 @@ pntrString *pntrTempAllocStack[M_MAX_ALLOC_STACK];
  * allocates a \ref block capable of holding \p size \ref pntrString entries
  * and pushes it onto the \ref pntrTempAllocStack.
  * \par size == 0
- * pops off all entries from the \ref pntrTempAllocStack and adds them to the
- * \ref memFreePool.
+ * pops off all entries from index \ref g_pntrStartTempAllocStack on from
+ * \ref pntrTempAllocStack and adds them to the \ref memFreePool.
  * \param[in] size count of \ref pntrString entries.  This value must include
  *   a terminal NULL pointer if needed.
  * \return a pointer to the allocated \ref block, or NULL if deallocation
  *   requested
  * \pre
  *   \p size ==0: all entries in from \ref pntrTempAllocStack from
- *   \ref g_pntrTempAllocStackStart do not contain relevant data any more.
+ *   \ref g_pntrStartTempAllocStack do not contain relevant data any more.
  * \post
  *   - \p size > 0: memory for \p size entries is reserved in the \ref block
  *     "block's" header, but the data is still random.

src/mmdata.h

@@ -45,7 +45,7 @@
 /*E*/extern long db1;
 /*!
  * \var long db2
- * Bytes held in \ref blocks managed in \ref tempAllocStack
+ * Bytes held in \ref block "blocks" managed in \ref tempAllocStack
  * "temporary pointer stacks".
  */
 /*E*/extern long db2;
@@ -526,6 +526,25 @@ extern struct nullPntrStruct g_PntrNull;
  * \post The variable is initialized.
  */
 #define pntrString_def(x) pntrString *x = NULL_PNTRSTRING
+/*!
+ * \def free_pntrString
+ * \param[in,out] x variable name
+ * Assigns \ref NULL_PNTRSTRING to a variable \ref pntrString \p x.  Frees all
+ * \ref pntrTempAllocStack, beginning with index 
+ * \ref g_pntrStartTempAllocStack.  See \ref pntrLet.
+ * \pre
+ *   - the \ref block assigned to \p x does not contain any valuable data.
+ *   - all \ref pntrString elements freed in \ref pntrTempAllocStack can be
+ *     discarded without losing relevant references.
+ * \post
+ *   - \p x is assigned NULL_PNTRSTRING.
+ *   - The stack pointer of \ref pntrTempAllocStack is reset to
+ *     \ref g_pntrStartTempAllocStack and all referenced
+ *     \ref block "blocks" on and beyond that are returned to the
+ *     \ref memFreePool.
+ *   - updates \ref db3 and \ref poolTotalFree.
+ *   - Exit on out-of-memory
+ */
 #define free_pntrString(x) pntrLet(&x, NULL_PNTRSTRING)
 
 
@@ -692,7 +711,7 @@ long compressedProofSize(const nmbrString *proof, long statemNum);
  */
 extern long g_pntrTempAllocStackTop;   /* Top of stack for pntrTempAlloc function */
 /*!
- * \var long g_pntrTempAllocStackStart
+ * \var long g_pntrStartTempAllocStack
  *
  * Index of the first entry of the \ref stack "stack" \ref pntrTempAllocStack
  * eligible for deallocation on the next call to \ref pntrTempAlloc.  Entries
@@ -732,7 +751,7 @@ temp_pntrString *pntrMakeTempAlloc(pntrString *s);
  * \n
  * It is assumed that the value persisted in \p target is in fact computed from
  * temporary operands in \ref pntrTempAllocStack.  All blocks starting with
- * the element at \ref g_pntrTempAllocStackStart are returned to the
+ * the element at \ref g_pntrStartTempAllocStack are returned to the
  * \ref memFreePool.
  * \attention freed \ref block "blocks" contain \ref pntrString instances.
  *   See \ref pntrTempAllocStack to learn how this free process can be
@@ -754,7 +773,7 @@ temp_pntrString *pntrMakeTempAlloc(pntrString *s);
  *   - due to a possible reallocation the pointer \p target points to may
  *     change.
  *   - The stack pointer of \ref pntrTempAllocStack is reset to
- *     \ref g_pntrTempAllocStackStart and all referenced
+ *     \ref g_pntrStartTempAllocStack and all referenced
  *     \ref block "blocks" on and beyond that are returned to the
  *     \ref memFreePool.
  *   - updates \ref db3 and \ref poolTotalFree.

src/mmvstr.h

@@ -301,16 +301,16 @@ void freeTempAlloc(void);
  * \pre
  * - \ref g_startTempAllocStack contains the starting index of entries in
  *   \ref tempAllocStack, that is going to be deallocated.
- * - The destination of this function must either be empty, or uniquely point
- *   to a \ref vstring, but not any of the \ref temp_vstring;
- * - The destination need not provide enough space for the source.  If
+ * - The \p target of this function must either be empty, or uniquely point
+ *   to a \ref vstring, but not to any of the \ref temp_vstring;
+ * - The \p target need not provide enough space for the source.  If
  *   necessary, it is reallocated;
  * \post
  * - Entries in \ref tempAllocStack from \ref g_startTempAllocStack (on entry
  *   to the function) are deallocated;
  * - The stack pointer in \ref g_tempAllocStackTop is set to
  *   \ref g_startTempAllocStack (on entry to the function);
- * - If the assigned value is the empty string, but the destination not, it is
+ * - If the assigned value is the empty string, but the \p target not, it is
  *   freed and assigned to a constant "";
  * - \ref db is updated.
  * \bug In an out-of-memory situation the program is not exited