plugins/include/files.inc
changeset 619 6934bf39171e
parent 475 bb11d7eaae0f
child 621 5a0f5014aac1
     1.1 --- a/plugins/include/files.inc	Thu Mar 15 20:10:25 2007 +0000
     1.2 +++ b/plugins/include/files.inc	Thu Mar 15 20:44:23 2007 +0000
     1.3 @@ -18,8 +18,11 @@
     1.4  #endif
     1.5  #define _files_included
     1.6  
     1.7 -/* @note All paths in SourceMod natives are relative to the mod folder unless otherwise noted. */
     1.8 - 
     1.9 +/* @global All paths in SourceMod natives are relative to the mod folder unless otherwise noted. */
    1.10 +
    1.11 +/**
    1.12 + * File inode types.
    1.13 + */
    1.14  enum FileType
    1.15  {
    1.16  	FileType_Unknown = 0,	/* Unknown file type (device/socket) */
    1.17 @@ -27,15 +30,18 @@
    1.18  	FileType_File = 2,		/* File is a file */
    1.19  };
    1.20  
    1.21 -#define PLATFORM_MAX_PATH		256
    1.22 +#define PLATFORM_MAX_PATH		256		/**< Maximum path length. */
    1.23  
    1.24 -#define SEEK_SET 0
    1.25 -#define SEEK_CUR 1
    1.26 -#define SEEK_END 2
    1.27 +#define SEEK_SET 0						/**< Seek from start. */
    1.28 +#define SEEK_CUR 1						/**< Seek from current position. */
    1.29 +#define SEEK_END 2						/**< Seek from end position. */
    1.30  
    1.31 +/**
    1.32 + * Path types.
    1.33 + */
    1.34  enum PathType
    1.35  {
    1.36 -	Path_SM,		/* SourceMod root folder */	
    1.37 +	Path_SM,		/**< SourceMod root folder */	
    1.38  };
    1.39  
    1.40  /**