Explorar el Código

cmStack.h : Added comments.

master
kevin hace 11 años
padre
commit
1431685ef3
Se han modificado 1 ficheros con 3 adiciones y 0 borrados
  1. 3
    0
      cmStack.h

+ 3
- 0
cmStack.h Ver fichero

@@ -42,12 +42,15 @@ extern "C" {
42 42
   const void* cmStackTop(     cmStackH_t h );
43 43
 
44 44
   // Set the value of 'dataEleCnt' elements on the stack.
45
+  // The top element is at index cmStackCount() - 1.
45 46
   cmStRC_t    cmStackSet(     cmStackH_t h, unsigned index, const void* data, unsigned dataEleCnt );
46 47
 
47 48
   // Copy 'dataEleCnt' elements into the buffer pointed to by 'data'.
49
+  // The top element is at index cmStackCount() - 1.
48 50
   cmStRC_t    cmStackGetN(    cmStackH_t h, unsigned index, void* data, unsigned dataEleCnt );
49 51
 
50 52
   // Return a pointer to a single element on the stack.
53
+  // The top element is at index cmStackCount() - 1.
51 54
   const void* cmStackGet(     cmStackH_t h, unsigned index );
52 55
 
53 56
   // Convert the internal representation of the stack to a linear array and return

Loading…
Cancelar
Guardar