Changed PHYSFS_file from a typedef to a #define for legacy code.
authorRyan C. Gordon <icculus@icculus.org>
Fri, 16 Mar 2007 22:06:04 +0000
changeset 830 adf9646a3b77
parent 829 5eaa78e63706
child 831 da5b8877b59d
Changed PHYSFS_file from a typedef to a #define for legacy code.
CHANGELOG.txt
physfs.h
--- a/CHANGELOG.txt	Thu Mar 15 08:19:17 2007 +0000
+++ b/CHANGELOG.txt	Fri Mar 16 22:06:04 2007 +0000
@@ -2,6 +2,9 @@
  * CHANGELOG.
  */
 
+03162007 - Changed PHYSFS_file from a typedef to a #define (in case it would
+           cause an aggressive compiler to think you're passing the wrong type
+           to a function) and added Doxygen comments to explain it.
 03152007 - Bunch of work on Unicode...added case-folding stricmp, removed
            platform-specific stricmp implementations, changed appropriate
            calls to an ASCII-only stricmp that ignores locale. Fixed case on
--- a/physfs.h	Thu Mar 15 08:19:17 2007 +0000
+++ b/physfs.h	Fri Mar 16 22:06:04 2007 +0000
@@ -339,7 +339,19 @@
     void *opaque;  /**< That's all you get. Don't touch. */
 } PHYSFS_File;
 
-typedef PHYSFS_File PHYSFS_file;  /* for backwards compatibility with 1.0 */
+
+/**
+ * \def PHYSFS_file
+ * \brief 1.0 API compatibility define.
+ *
+ * PHYSFS_file is identical to PHYSFS_File. This #define is here for backwards
+ *  compatibility with the 1.0 API, which had an inconsistent capitalization
+ *  convention in this case. New code should use PHYSFS_File, as this #define
+ *  may go away someday.
+ *
+ * \sa PHYSFS_File
+ */
+#define PHYSFS_file PHYSFS_File
 
 
 /**