Added some FIXMEs and deprecated PHYSFS_getLastError().
authorRyan C. Gordon <icculus@icculus.org>
Sat, 12 Aug 2017 02:21:11 -0400
changeset 1560 6db57d6bff9a
parent 1559 aaee2b83291f
child 1561 422fbc7f1816
Added some FIXMEs and deprecated PHYSFS_getLastError().
src/physfs.h
--- a/src/physfs.h	Sat Aug 12 02:19:22 2017 -0400
+++ b/src/physfs.h	Sat Aug 12 02:21:11 2017 -0400
@@ -4,6 +4,9 @@
  * Main header file for PhysicsFS.
  */
 
+// !!! FIXME-3.0: all the "you can get the error from getLastError()" should
+// !!! FIXME-3.0:  be updated for getLastErrorCode.
+
 /**
  * \mainpage PhysicsFS
  *
@@ -604,6 +607,8 @@
  * \fn const char *PHYSFS_getLastError(void)
  * \brief Get human-readable error information.
  *
+ * \deprecated Use PHYSFS_getLastErrorCode() and PHYSFS_getErrorByCode() instead.
+ *
  * \warning As of PhysicsFS 2.1, this function has been nerfed.
  *          Before PhysicsFS 2.1, this function was the only way to get
  *          error details beyond a given function's basic return value.
@@ -648,7 +653,7 @@
  * \sa PHYSFS_getLastErrorCode
  * \sa PHYSFS_getErrorByCode
  */
-PHYSFS_DECL const char *PHYSFS_getLastError(void);
+PHYSFS_DECL const char *PHYSFS_getLastError(void) PHYSFS_DEPRECATED;
 
 
 /**
@@ -958,7 +963,7 @@
  *                         yourself.
  *
  *    \param archivesFirst Non-zero to prepend the archives to the search path.
- *                          Zero to append them. Ignored if !(archiveExt).
+ *                         Zero to append them. Ignored if !(archiveExt).
  *
  *  \return nonzero on success, zero on error. Specifics of the error can be
  *          gleaned from PHYSFS_getLastError().