summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorscuri <scuri>2009-07-16 13:50:58 +0000
committerscuri <scuri>2009-07-16 13:50:58 +0000
commitcc64196862e37f10714a7f5466e14a4691f1be3f (patch)
tree41442feb228261ebaf0cfb129f8e1c430bf511ed /include
parent4ea6e8cfe0246827d21e39a09dc2af35b44ce566 (diff)
*** empty log message ***
Diffstat (limited to 'include')
-rw-r--r--include/im_attrib.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/include/im_attrib.h b/include/im_attrib.h
index 2a7cfb6..3dec798 100644
--- a/include/im_attrib.h
+++ b/include/im_attrib.h
@@ -96,13 +96,16 @@ public:
void CopyFrom(const imAttribArray& table)
{ imAttribArrayCopyFrom(ptable, table.ptable); }
- /** Inserts an attribute into the array. \n
- * Data is duplicated if not NULL, else data is initialized with zeros.
+ /** Inserts one attribute into the array.
+ * The attribute data is a simple array of data_type elements of count length. \n
+ * Data is duplicated if not NULL, else data is initialized with zeros.
+ * When NULL is specified use the Get method to retrieve a pointer to the data
+ * so you can initialize it with other values.
* See also \ref imDataType. */
void Set(int index, const char* name, int data_type, int count, const void* data)
{ imAttribArraySet(ptable, index, name, data_type, count, data); }
- /** Finds an attribute in the array.
+ /** Finds one attribute in the array.
* Returns the attribute if found, NULL otherwise.
* See also \ref imDataType. */
const void* Get(int index, char *name = 0, int *data_type = 0, int *count = 0) const