Browse Source

cmArray.h: Updated comments.

master
kevin 11 years ago
parent
commit
0389468c85
1 changed files with 7 additions and 0 deletions
  1. 7
    0
      cmArray.h

+ 7
- 0
cmArray.h View File

@@ -26,9 +26,16 @@ enum
26 26
   unsigned    cmArrayExpandCount( cmArrayH_t h );
27 27
   unsigned    cmArrayCount(  cmArrayH_t h );
28 28
   cmArRC_t    cmArrayClear(  cmArrayH_t h, bool releaseFl );
29
+
30
+  // Returns a pointer to the first pushed element.
31
+  // Set 'data' to NULL to create 'dataEleCnt' new zeroed elements.
29 32
   void*       cmArrayPush(   cmArrayH_t h, const void* data, unsigned dataEleCnt );
33
+
34
+  // Decreaese the array count by 'eleCnt'.
30 35
   cmArRC_t    cmArrayPop(    cmArrayH_t h, unsigned eleCnt );
36
+
31 37
   // If 'data' is NULL then array[idx:idx+dataEleCnt] is zeroed.
38
+  // Returns a ptr to the first set element.
32 39
   void*       cmArraySet(    cmArrayH_t h, unsigned index, const void* data, unsigned dataEleCnt );
33 40
   const void* cmArrayGet(    cmArrayH_t h, unsigned index );
34 41
 

Loading…
Cancel
Save