Просмотр исходного кода

Comment tweaks (FIXME additions, typo corrections, etc).

Ryan C. Gordon 13 лет назад
Родитель
Сommit
1ed8bc07c0
2 измененных файлов с 9 добавлено и 2 удалено
  1. 7 0
      src/physfs.h
  2. 2 2
      src/physfs_internal.h

+ 7 - 0
src/physfs.h

@@ -3384,8 +3384,15 @@ typedef struct PHYSFS_Archiver
      * This is used to identify your archive, and is returned in
      *  PHYSFS_supportedArchiveTypes().
      */
+// !! FIXME: should this be const?
     const PHYSFS_ArchiveInfo info;
 
+    /**
+     * !!! FIXME: document me.
+     */    
+    int supportsSymlinks;
+
+// !!! FIXME: documentation: \brief?
     /**
      * \brief
      *

+ 2 - 2
src/physfs_internal.h

@@ -548,11 +548,11 @@ void *__PHYSFS_platformGetThreadID(void);
 
 /*
  * Enumerate a directory of files. This follows the rules for the
- *  PHYSFS_Archiver->enumerateFiles() method (see above), except that the
+ *  PHYSFS_Archiver::enumerateFiles() method (see above), except that the
  *  (dirName) that is passed to this function is converted to
  *  platform-DEPENDENT notation by the caller. The PHYSFS_Archiver version
  *  uses platform-independent notation. Note that ".", "..", and other
- *  metaentries should always be ignored.
+ *  meta-entries should always be ignored.
  */
 void __PHYSFS_platformEnumerateFiles(const char *dirname,
                                      PHYSFS_EnumFilesCallback callback,