From 43522c5f2a12dc0cf3cda733e4fb5c04cd62a154 Mon Sep 17 00:00:00 2001
From: scuri <scuri>
Date: Wed, 19 Aug 2009 18:39:31 +0000
Subject: *** empty log message ***

---
 include/im.h        | 13 +++++++++----
 include/im_attrib.h |  1 +
 2 files changed, 10 insertions(+), 4 deletions(-)

(limited to 'include')

diff --git a/include/im.h b/include/im.h
index a6673cb..a324199 100644
--- a/include/im.h
+++ b/include/im.h
@@ -114,9 +114,13 @@ void imFileClose(imFile* ifile);
 void* imFileHandle(imFile* ifile, int index);  
 
 /** Returns file information. 
- *  image_count is the number of images in a stack or 
- *  the number of frames in a video/animation or the depth of a volume data. \n
- *  compression and image_count can be NULL.
+ * image_count is the number of images in a stack or 
+ * the number of frames in a video/animation or the depth of a volume data. \n
+ * compression and image_count can be NULL. \n
+ * These informations are also available as attributes:
+ * \verbatim FileFormat (string) \endverbatim
+ * \verbatim FileCompression (string) \endverbatim
+ * \verbatim FileImageCount IM_INT (1) \endverbatim
  * See also \ref format.
  *
  * \verbatim ifile:GetInfo() -> format: string, compression: string, image_count: number [in Lua 5] \endverbatim
@@ -134,7 +138,8 @@ void imFileSetInfo(imFile* ifile, const char* compression);
 
 /** Changes an extended attribute. \n
  * The data will be internally duplicated. \n
- * If data is NULL the attribute is removed.
+ * If data is NULL the attribute is removed. 
+ * If data_type is BYTE then count can be -1 to indicate a NULL terminated string.
  * See also \ref imDataType.
  *
  * \verbatim ifile:SetAttribute(attrib: string, data_type: number, data: table of numbers or string) [in Lua 5] \endverbatim
diff --git a/include/im_attrib.h b/include/im_attrib.h
index 3dec798..76302ef 100644
--- a/include/im_attrib.h
+++ b/include/im_attrib.h
@@ -46,6 +46,7 @@ public:
     { imAttribTableCopyFrom(ptable, table.ptable); }
 
   /** Inserts an attribute into the table. \n 
+   * If data_type is BYTE then count can be -1 to indicate a NULL terminated string.
    * Data is duplicated if not NULL, else data is initialized with zeros.
    * See also \ref imDataType. */
   void Set(const char* name, int data_type, int count, const void* data)
-- 
cgit v1.2.3