physfs.h
changeset 830 adf9646a3b77
parent 828 ee871d51510d
child 831 da5b8877b59d
--- 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
 
 
 /**