@@ -719,7 +719,7 @@ extern PHYSFS_DECL const PHYSFS_ArchiveInfo ** PHYSFS_CALL PHYSFS_supportedArchi
719719 * before PhysicsFS 2.1.0.
720720 *
721721 * \param listVar List of information specified as freeable by this function.
722- * Passing NULL is safe; it is a valid no-op .
722+ * May be NULL .
723723 *
724724 * \threadsafety It is safe to call this function from any thread.
725725 *
@@ -967,15 +967,18 @@ extern PHYSFS_DECL const char * PHYSFS_CALL PHYSFS_getWriteDir(void);
967967 *
968968 * Set a new write dir. This will override the previous setting.
969969 *
970+ * All attempts to open a file for writing via PhysicsFS will fail until there
971+ * is a valid write dir specified through this function.
972+ *
970973 * This call will fail (and fail to change the write dir) if the current write
971974 * dir still has files open in it.
972975 *
976+ * Passing a NULL here disables the write dir, so no files can be opened for
977+ * writing via PhysicsFS, until a later call specifies a new write dir.
978+ *
973979 * \param newDir The new directory to be the root of the write dir, specified
974- * in platform-dependent notation. Setting to NULL disables the
975- * write dir, so no files can be opened for writing via
976- * PhysicsFS.
977- * \returns non-zero on success, zero on failure. All attempts to open a file
978- * for writing via PhysicsFS will fail until this call succeeds. Use
980+ * in platform-dependent notation. May be NULL.
981+ * \returns non-zero on success, zero on failure. Use
979982 * PHYSFS_getLastErrorCode() to obtain the specific error.
980983 *
981984 * \threadsafety It is safe to call this function from any thread.
@@ -3679,7 +3682,7 @@ typedef struct PHYSFS_Io
36793682 * it is unsafe to touch that instance again and will discard any
36803683 * references to it.
36813684 *
3682- * \param s The i/o instance to destroy.
3685+ * \param io The i/o instance to destroy.
36833686 */
36843687 void (PHYSFS_CALL * destroy )(struct PHYSFS_Io * io );
36853688} PHYSFS_Io ;
0 commit comments