Răsfoiți Sursa

physfs.h: Corrected some documentation.

(cherry picked from commit b545573a0745279e7370ffe2559a93851f69b1b8)
Ryan C. Gordon 5 luni în urmă
părinte
comite
30b9423d68
1 a modificat fișierele cu 4 adăugiri și 1 ștergeri
  1. 4 1
      src/physfs.h

+ 4 - 1
src/physfs.h

@@ -3154,12 +3154,15 @@ typedef struct PHYSFS_Io
      *  being destroyed separately (so, for example: they can't share a file
      *  being destroyed separately (so, for example: they can't share a file
      *  handle; they each need their own).
      *  handle; they each need their own).
      *
      *
+     * The current seek position does not need to be duplicated; the caller
+     *  is expected to explicitly seek the duplicated object before using it.
+     *
      * If you can't duplicate a handle, it's legal to return NULL, but you
      * If you can't duplicate a handle, it's legal to return NULL, but you
      *  almost certainly need this functionality if you want to use this to
      *  almost certainly need this functionality if you want to use this to
      *  PHYSFS_Io to back an archive.
      *  PHYSFS_Io to back an archive.
      *
      *
      *   \param io The i/o instance to duplicate.
      *   \param io The i/o instance to duplicate.
-     *  \return A new value for a stream's (opaque) field, or NULL on error.
+     *  \return A new instance of `io` that can operate independently.
      */
      */
     struct PHYSFS_Io *(*duplicate)(struct PHYSFS_Io *io);
     struct PHYSFS_Io *(*duplicate)(struct PHYSFS_Io *io);