Changed PHYSFS_file from a typedef to a #define for legacy code.

icculus · Mar 16, 2007 · 237170e · 237170e
1 parent 503fafa
commit 237170e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -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

diff --git a/physfs.h b/physfs.h
@@ -339,7 +339,19 @@ typedef struct
     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
 
 
 /**