summaryrefslogtreecommitdiff
path: root/legacy/eet/src
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2012-04-12 06:28:55 +0000
committerCarsten Haitzler <raster@rasterman.com>2012-04-12 06:28:55 +0000
commit32e5934717897e30070f874694ede68eee02fb21 (patch)
tree830a1e3811f30482fe1e3932e0685dc791ec9dc3 /legacy/eet/src
parent7d464af0a1b5c8b364fe0ffcd2f63ded8b15b08a (diff)
add docs explaining the internal cache on close for onefang.
SVN revision: 70118
Diffstat (limited to 'legacy/eet/src')
-rw-r--r--legacy/eet/src/lib/Eet.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/legacy/eet/src/lib/Eet.h b/legacy/eet/src/lib/Eet.h
index 38b40a7cc9..10d94f5ed8 100644
--- a/legacy/eet/src/lib/Eet.h
+++ b/legacy/eet/src/lib/Eet.h
@@ -585,12 +585,16 @@ eet_mode_get(Eet_File *ef);
585 * 585 *
586 * This function will flush any pending writes to disk if the eet file 586 * This function will flush any pending writes to disk if the eet file
587 * was opened for write, and free all data associated with the file handle 587 * was opened for write, and free all data associated with the file handle
588 * and file, and close the file. 588 * and file, and close the file. If it was opened for read (or read/write),
589 * the file handle may still be held open internally for caching purposes.
590 * To flush speuclatively held eet file handles use eet_clearcache().
589 * 591 *
590 * If the eet file handle is not valid nothing will be done. 592 * If the eet file handle is not valid nothing will be done.
591 * 593 *
592 * @since 1.0.0 594 * @since 1.0.0
593 * @ingroup Eet_File_Group 595 * @ingroup Eet_File_Group
596 *
597 * @see eet_clearcache()
594 */ 598 */
595EAPI Eet_Error 599EAPI Eet_Error
596eet_close(Eet_File *ef); 600eet_close(Eet_File *ef);