fix eet docs.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eet@41826 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/ChangeLog b/ChangeLog
index ddc1daa..8a6315f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -214,3 +214,8 @@
        * Fix eet data encode to encode empty structs etc. so save saves
           something as opposed to nothing
 
+2009-08-16  Carsten Haitzler (The Rasterman)
+
+       * Fix documentation of eet_data_write() and eet_write() for return
+          value to return # of bytes written, not 1 or 0
+

diff --git a/src/lib/Eet.h b/src/lib/Eet.h
index 503ce6f..30c7d6b 100644 (file)
--- a/src/lib/Eet.h
+++ b/src/lib/Eet.h
@@ -413,7 +413,7 @@ extern "C" {
     * @param data Pointer to the data to be stored.
     * @param size Length in bytes in the data to be stored.
     * @param compress Compression flags (1 == compress, 0 = don't compress).
-    * @return Success or failure of the write.
+    * @return bytes written on successful write, 0 on failure.
     *
     * This function will write the specified chunk of data to the eet file
     * and return greater than 0 on success. 0 will be returned on failure.
@@ -1146,7 +1146,7 @@ extern "C" {
     * @param name The key to store the data under in the eet file.
     * @param data A pointer to the data structure to ssave and encode.
     * @param compress Compression flags for storage.
-    * @return 1 on successful write, 0 on failure.
+    * @return bytes written on successful write, 0 on failure.
     *
     * This function is the reverse of eet_data_read(), saving a data structure
     * to an eet file.