More doc tweaks.
authorRyan C. Gordon <icculus@icculus.org>
Sun, 11 Mar 2012 05:05:02 -0400
changeset 1214 374be12cf9c8
parent 1213 050ee17c6e99
child 1215 0a8369723de7
More doc tweaks.
docs/TODO.txt
src/physfs_internal.h
--- a/docs/TODO.txt	Sun Mar 11 04:19:36 2012 -0400
+++ b/docs/TODO.txt	Sun Mar 11 05:05:02 2012 -0400
@@ -22,7 +22,8 @@
 - Deprecate PHYSFS_setSaneConfig(). It really should have been in the extras
   directory.
 - Clean up the sources to match my ever-changing coding style. :)
-- Get current CD list from windows without blocking? Is it possible?
+- Get current CD list from windows without blocking?
+  Read this: http://support.microsoft.com/kb/163503
 
 
 From http://icculus.org/pipermail/physfs/2010-January/000821.html ...
--- a/src/physfs_internal.h	Sun Mar 11 04:19:36 2012 -0400
+++ b/src/physfs_internal.h	Sun Mar 11 05:05:02 2012 -0400
@@ -859,7 +859,7 @@
  * This is a convenience function; you might want to hack something out that
  *  is less generic (and therefore more efficient).
  *
- * Be sure to free() the return value when done with it.
+ * Be sure to allocator.Free() the return value when done with it.
  */
 char *__PHYSFS_convertToDependent(const char *prepend,
                                   const char *dirName,
@@ -1230,21 +1230,21 @@
  * Calculate the base dir, if your platform needs special consideration.
  *  Just return NULL if the standard routines will suffice. (see
  *  calculateBaseDir() in physfs.c ...)
- *  Caller will free() the retval if it's not NULL.
+ *  Caller will allocator.Free() the retval if it's not NULL.
  */
 char *__PHYSFS_platformCalcBaseDir(const char *argv0);
 
 /*
  * Get the platform-specific user name.
- *  Caller will free() the retval if it's not NULL. If it's NULL, the username
- *  will default to "default".
+ *  Caller will allocator.Free() the retval if it's not NULL. If it's NULL,
+ *  the username will default to "default".
  */
 char *__PHYSFS_platformGetUserName(void);
 
 /*
  * Get the platform-specific user dir.
- *  Caller will free() the retval if it's not NULL. If it's NULL, the userdir
- *  will default to basedir/username.
+ *  Caller will allocator.Free() the retval if it's not NULL. If it's NULL,
+ *  the userdir will default to basedir/username.
  */
 char *__PHYSFS_platformGetUserDir(void);
 
@@ -1272,7 +1272,7 @@
  *  __PHYSFS_convertToDependent() as a passthrough, which may fit the bill
  *  already.
  *
- * Be sure to free() the return value when done with it.
+ * Be sure to allocator.Free() the return value when done with it.
  */
 char *__PHYSFS_platformCvtToDependent(const char *prepend,
                                       const char *dirName,
@@ -1297,8 +1297,7 @@
 /*
  * Get the current working directory. The return value should be an
  *  absolute path in platform-dependent notation. The caller will deallocate
- *  the return value with the standard C runtime free() function when it
- *  is done with it.
+ *  the return value with allocator.Free() when it is done with it.
  * On error, return NULL and set the error message.
  */
 char *__PHYSFS_platformCurrentDir(void);