From 1431685ef32e8a8b5adf5b88d94efc52c3a57987 Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 14 Nov 2013 16:44:34 -0500 Subject: [PATCH] cmStack.h : Added comments. --- cmStack.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cmStack.h b/cmStack.h index 63d06db..189acc2 100644 --- a/cmStack.h +++ b/cmStack.h @@ -42,12 +42,15 @@ extern "C" { const void* cmStackTop( cmStackH_t h ); // Set the value of 'dataEleCnt' elements on the stack. + // The top element is at index cmStackCount() - 1. cmStRC_t cmStackSet( cmStackH_t h, unsigned index, const void* data, unsigned dataEleCnt ); // Copy 'dataEleCnt' elements into the buffer pointed to by 'data'. + // The top element is at index cmStackCount() - 1. cmStRC_t cmStackGetN( cmStackH_t h, unsigned index, void* data, unsigned dataEleCnt ); // Return a pointer to a single element on the stack. + // The top element is at index cmStackCount() - 1. const void* cmStackGet( cmStackH_t h, unsigned index ); // Convert the internal representation of the stack to a linear array and return