From: Matthias Braun <matze@braunis.de>
Date: Fri, 28 May 2010 10:46:30 +0000 (+0000)
Subject: clarify documentation for array Allocs
X-Git-Url: http://nsz.repo.hu/git/?a=commitdiff_plain;h=0e92ace4d07713a9c92f41e369348ba282d919f2;p=libfirm

clarify documentation for array Allocs

[r27597]
---

diff --git a/include/libfirm/ircons.h b/include/libfirm/ircons.h
index 1036d81f7..7e0792787 100644
--- a/include/libfirm/ircons.h
+++ b/include/libfirm/ircons.h
@@ -908,9 +908,11 @@
  *
  *    Parameters:
  *      *store       The memory which shall contain the new variable.
- *      *count       This field is for allocating arrays, i.e., it gives the multiple
- *                   of the size of alloc_type to allocate memory for.
- *      *alloc_type  The type of the allocated variable.
+ *      *count       This field is for allocating arrays, it specifies how
+ *                   many array elements are to be allocated.
+ *      *alloc_type  The type of the allocated variable. In case of allocating
+ *                   arrays this has to be the array type, not the type of the
+ *                   array elements.
  *      where        Where to allocate the variable, either heap_alloc or stack_alloc.
  *
  *    Inputs: