Browse Source

cmArray.h: Update comments.

master
kevin 11 years ago
parent
commit
da5ce4234b
1 changed files with 8 additions and 0 deletions
  1. 8
    0
      cmArray.h

+ 8
- 0
cmArray.h View File

42
 
42
 
43
 
43
 
44
 #define cmArrayPtr(t,h,i)     ((t*)cmArrayGet(h,i))
44
 #define cmArrayPtr(t,h,i)     ((t*)cmArrayGet(h,i))
45
+
46
+  // Return a ptr to the base of the array.
45
 #define cmArrayBase(t,h)     ((t*)cmArrayGet(h,0))
47
 #define cmArrayBase(t,h)     ((t*)cmArrayGet(h,0))
48
+
49
+  // Return a ptr to the ith element
46
 #define cmArrayEle(t,h,i)    (*(t*)cmArrayGet(h,i))
50
 #define cmArrayEle(t,h,i)    (*(t*)cmArrayGet(h,i))
51
+
52
+  // Zero the ith element
47
 #define cmArrayClr(t,h,i)    ((t*)cmArraySet(h,i,NULL,1))
53
 #define cmArrayClr(t,h,i)    ((t*)cmArraySet(h,i,NULL,1))
54
+
55
+  // Zero elements i:i+n-1
48
 #define cmArrayClrN(t,h,i,n) ((t*)cmArraySet(h,i,NULL,n))
56
 #define cmArrayClrN(t,h,i,n) ((t*)cmArraySet(h,i,NULL,n))
49
 
57
 
50
 #ifdef __cplusplus
58
 #ifdef __cplusplus

Loading…
Cancel
Save