1.1 --- a/plugins/include/files.inc Thu May 17 17:17:14 2007 +0000
1.2 +++ b/plugins/include/files.inc Fri May 18 18:00:35 2007 +0000
1.3 @@ -45,7 +45,7 @@
1.4 };
1.5
1.6 /**
1.7 - * @brief Builds a path relative to the SourceMod folder.
1.8 + * Builds a path relative to the SourceMod folder.
1.9 *
1.10 * @param type Type of path to build as the base.
1.11 * @param buffer Buffer to store the path.
1.12 @@ -57,7 +57,7 @@
1.13 native BuildPath(PathType:type, String:buffer[], maxlength, const String:fmt[], any:...);
1.14
1.15 /**
1.16 - * @brief Opens a directory/folder for contents enumeration.
1.17 + * Opens a directory/folder for contents enumeration.
1.18 * @note Directories are closed with CloseHandle().
1.19 * @note Directories Handles can be cloned.
1.20 *
1.21 @@ -67,7 +67,7 @@
1.22 native Handle:OpenDirectory(const String:path[]);
1.23
1.24 /**
1.25 - * @brief Reads the current directory entry as a local filename, then moves to the next file.
1.26 + * Reads the current directory entry as a local filename, then moves to the next file.
1.27 * @note Contents of buffers are undefined when returning false.
1.28 * @note Both the '.' and '..' automatic directory entries will be retrieved for Windows and Linux.
1.29 *
1.30 @@ -81,7 +81,7 @@
1.31 native bool:ReadDirEntry(Handle:dir, String:buffer[], maxlength, &FileType:type=FileType_Unknown);
1.32
1.33 /**
1.34 - * @brief Opens a file.
1.35 + * Opens a file.
1.36 * @note Files are closed with CloseHandle().
1.37 * @note File Handles can be cloned.
1.38 *
1.39 @@ -92,7 +92,7 @@
1.40 native Handle:OpenFile(const String:file[], const String:mode[]);
1.41
1.42 /**
1.43 - * @brief Deletes a file.
1.44 + * Deletes a file.
1.45 *
1.46 * @param path Path of the file to delete.
1.47 * @return True on success, false otherwise.
1.48 @@ -100,7 +100,7 @@
1.49 native bool:DeleteFile(const String:path[]);
1.50
1.51 /**
1.52 - * @brief Reads a line from a text file.
1.53 + * Reads a line from a text file.
1.54 *
1.55 * @param hndl Handle to the file.
1.56 * @param buffer String buffer to hold the line.
1.57 @@ -110,7 +110,7 @@
1.58 native bool:ReadFileLine(Handle:hndl, String:buffer[], maxlength);
1.59
1.60 /**
1.61 - * @brief Tests if the end of file has been reached.
1.62 + * Tests if the end of file has been reached.
1.63 *
1.64 * @param file Handle to the file.
1.65 * @return True if end of file has been reached, false otherwise.
1.66 @@ -118,7 +118,7 @@
1.67 native bool:IsEndOfFile(Handle:file);
1.68
1.69 /**
1.70 - * @brief Sets the file position indicator.
1.71 + * Sets the file position indicator.
1.72 *
1.73 * @param file Handle to the file.
1.74 * @param position Position relative to what is specified in whence.
1.75 @@ -128,7 +128,7 @@
1.76 native bool:FileSeek(Handle:file, position, whence);
1.77
1.78 /**
1.79 - * @brief Get current position in the file.
1.80 + * Get current position in the file.
1.81 *
1.82 * @param file Handle to the file.
1.83 * @return Value for the file position indicator.
1.84 @@ -136,7 +136,7 @@
1.85 native FilePosition(Handle:file);
1.86
1.87 /**
1.88 - * @brief Checks if a file exists.
1.89 + * Checks if a file exists.
1.90 *
1.91 * @param path Path to the file.
1.92 * @return True if the file exists, false otherwise.
1.93 @@ -144,7 +144,7 @@
1.94 native bool:FileExists(const String:path[]);
1.95
1.96 /**
1.97 - * @brief Renames a file.
1.98 + * Renames a file.
1.99 *
1.100 * @param newpath New path to the file.
1.101 * @param oldpath Path to the existing file.
1.102 @@ -153,7 +153,7 @@
1.103 native bool:RenameFile(const String:newpath[], const String:oldpath[]);
1.104
1.105 /**
1.106 - * @brief Checks if a directory exists.
1.107 + * Checks if a directory exists.
1.108 *
1.109 * @param path Path to the directory.
1.110 * @return True if the directory exists, false otherwise.
1.111 @@ -161,7 +161,7 @@
1.112 native bool:DirExists(const String:path[]);
1.113
1.114 /**
1.115 - * @brief Get the file size in bytes.
1.116 + * Get the file size in bytes.
1.117 *
1.118 * @param path Path to the file.
1.119 * @return File size in bytes, -1 if file not found.
1.120 @@ -169,7 +169,7 @@
1.121 native FileSize(const String:path[]);
1.122
1.123 /**
1.124 - * @brief Removes a directory.
1.125 + * Removes a directory.
1.126 * @note On most Operating Systems you cannot remove a directory which has files inside it.
1.127 *
1.128 * @param path Path to the directory.
1.129 @@ -178,7 +178,7 @@
1.130 native bool:RemoveDir(const String:path[]);
1.131
1.132 /**
1.133 - * @brief Writes a line of text in a file.
1.134 + * Writes a line of text in a file.
1.135 * @note This native will append the newline character.
1.136 *
1.137 * @param hndl Handle to the file.