removed @brief syntax from early includes
--HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40818
This commit is contained in:
parent
5d4693c6f9
commit
0fb64f891d
@ -136,7 +136,7 @@ enum AdmAccessMode
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Represents the various cache regions.
|
* Represents the various cache regions.
|
||||||
*/
|
*/
|
||||||
enum AdminCachePart
|
enum AdminCachePart
|
||||||
{
|
{
|
||||||
@ -200,7 +200,7 @@ native UnsetCommandOverride(const String:cmd[], OverrideType:type);
|
|||||||
native GroupId:CreateAdmGroup(const String:group_name[]);
|
native GroupId:CreateAdmGroup(const String:group_name[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Finds a group by name.
|
* Finds a group by name.
|
||||||
*
|
*
|
||||||
* @param group_name String containing the group name.
|
* @param group_name String containing the group name.
|
||||||
* @return A group id, or INVALID_GROUP_ID if not found.
|
* @return A group id, or INVALID_GROUP_ID if not found.
|
||||||
|
@ -45,7 +45,7 @@ enum PathType
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Builds a path relative to the SourceMod folder.
|
* Builds a path relative to the SourceMod folder.
|
||||||
*
|
*
|
||||||
* @param type Type of path to build as the base.
|
* @param type Type of path to build as the base.
|
||||||
* @param buffer Buffer to store the path.
|
* @param buffer Buffer to store the path.
|
||||||
@ -57,7 +57,7 @@ enum PathType
|
|||||||
native BuildPath(PathType:type, String:buffer[], maxlength, const String:fmt[], any:...);
|
native BuildPath(PathType:type, String:buffer[], maxlength, const String:fmt[], any:...);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Opens a directory/folder for contents enumeration.
|
* Opens a directory/folder for contents enumeration.
|
||||||
* @note Directories are closed with CloseHandle().
|
* @note Directories are closed with CloseHandle().
|
||||||
* @note Directories Handles can be cloned.
|
* @note Directories Handles can be cloned.
|
||||||
*
|
*
|
||||||
@ -67,7 +67,7 @@ native BuildPath(PathType:type, String:buffer[], maxlength, const String:fmt[],
|
|||||||
native Handle:OpenDirectory(const String:path[]);
|
native Handle:OpenDirectory(const String:path[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Reads the current directory entry as a local filename, then moves to the next file.
|
* Reads the current directory entry as a local filename, then moves to the next file.
|
||||||
* @note Contents of buffers are undefined when returning false.
|
* @note Contents of buffers are undefined when returning false.
|
||||||
* @note Both the '.' and '..' automatic directory entries will be retrieved for Windows and Linux.
|
* @note Both the '.' and '..' automatic directory entries will be retrieved for Windows and Linux.
|
||||||
*
|
*
|
||||||
@ -81,7 +81,7 @@ native Handle:OpenDirectory(const String:path[]);
|
|||||||
native bool:ReadDirEntry(Handle:dir, String:buffer[], maxlength, &FileType:type=FileType_Unknown);
|
native bool:ReadDirEntry(Handle:dir, String:buffer[], maxlength, &FileType:type=FileType_Unknown);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Opens a file.
|
* Opens a file.
|
||||||
* @note Files are closed with CloseHandle().
|
* @note Files are closed with CloseHandle().
|
||||||
* @note File Handles can be cloned.
|
* @note File Handles can be cloned.
|
||||||
*
|
*
|
||||||
@ -92,7 +92,7 @@ native bool:ReadDirEntry(Handle:dir, String:buffer[], maxlength, &FileType:type=
|
|||||||
native Handle:OpenFile(const String:file[], const String:mode[]);
|
native Handle:OpenFile(const String:file[], const String:mode[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Deletes a file.
|
* Deletes a file.
|
||||||
*
|
*
|
||||||
* @param path Path of the file to delete.
|
* @param path Path of the file to delete.
|
||||||
* @return True on success, false otherwise.
|
* @return True on success, false otherwise.
|
||||||
@ -100,7 +100,7 @@ native Handle:OpenFile(const String:file[], const String:mode[]);
|
|||||||
native bool:DeleteFile(const String:path[]);
|
native bool:DeleteFile(const String:path[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Reads a line from a text file.
|
* Reads a line from a text file.
|
||||||
*
|
*
|
||||||
* @param hndl Handle to the file.
|
* @param hndl Handle to the file.
|
||||||
* @param buffer String buffer to hold the line.
|
* @param buffer String buffer to hold the line.
|
||||||
@ -110,7 +110,7 @@ native bool:DeleteFile(const String:path[]);
|
|||||||
native bool:ReadFileLine(Handle:hndl, String:buffer[], maxlength);
|
native bool:ReadFileLine(Handle:hndl, String:buffer[], maxlength);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Tests if the end of file has been reached.
|
* Tests if the end of file has been reached.
|
||||||
*
|
*
|
||||||
* @param file Handle to the file.
|
* @param file Handle to the file.
|
||||||
* @return True if end of file has been reached, false otherwise.
|
* @return True if end of file has been reached, false otherwise.
|
||||||
@ -118,7 +118,7 @@ native bool:ReadFileLine(Handle:hndl, String:buffer[], maxlength);
|
|||||||
native bool:IsEndOfFile(Handle:file);
|
native bool:IsEndOfFile(Handle:file);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Sets the file position indicator.
|
* Sets the file position indicator.
|
||||||
*
|
*
|
||||||
* @param file Handle to the file.
|
* @param file Handle to the file.
|
||||||
* @param position Position relative to what is specified in whence.
|
* @param position Position relative to what is specified in whence.
|
||||||
@ -128,7 +128,7 @@ native bool:IsEndOfFile(Handle:file);
|
|||||||
native bool:FileSeek(Handle:file, position, whence);
|
native bool:FileSeek(Handle:file, position, whence);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Get current position in the file.
|
* Get current position in the file.
|
||||||
*
|
*
|
||||||
* @param file Handle to the file.
|
* @param file Handle to the file.
|
||||||
* @return Value for the file position indicator.
|
* @return Value for the file position indicator.
|
||||||
@ -136,7 +136,7 @@ native bool:FileSeek(Handle:file, position, whence);
|
|||||||
native FilePosition(Handle:file);
|
native FilePosition(Handle:file);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Checks if a file exists.
|
* Checks if a file exists.
|
||||||
*
|
*
|
||||||
* @param path Path to the file.
|
* @param path Path to the file.
|
||||||
* @return True if the file exists, false otherwise.
|
* @return True if the file exists, false otherwise.
|
||||||
@ -144,7 +144,7 @@ native FilePosition(Handle:file);
|
|||||||
native bool:FileExists(const String:path[]);
|
native bool:FileExists(const String:path[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Renames a file.
|
* Renames a file.
|
||||||
*
|
*
|
||||||
* @param newpath New path to the file.
|
* @param newpath New path to the file.
|
||||||
* @param oldpath Path to the existing file.
|
* @param oldpath Path to the existing file.
|
||||||
@ -153,7 +153,7 @@ native bool:FileExists(const String:path[]);
|
|||||||
native bool:RenameFile(const String:newpath[], const String:oldpath[]);
|
native bool:RenameFile(const String:newpath[], const String:oldpath[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Checks if a directory exists.
|
* Checks if a directory exists.
|
||||||
*
|
*
|
||||||
* @param path Path to the directory.
|
* @param path Path to the directory.
|
||||||
* @return True if the directory exists, false otherwise.
|
* @return True if the directory exists, false otherwise.
|
||||||
@ -161,7 +161,7 @@ native bool:RenameFile(const String:newpath[], const String:oldpath[]);
|
|||||||
native bool:DirExists(const String:path[]);
|
native bool:DirExists(const String:path[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Get the file size in bytes.
|
* Get the file size in bytes.
|
||||||
*
|
*
|
||||||
* @param path Path to the file.
|
* @param path Path to the file.
|
||||||
* @return File size in bytes, -1 if file not found.
|
* @return File size in bytes, -1 if file not found.
|
||||||
@ -169,7 +169,7 @@ native bool:DirExists(const String:path[]);
|
|||||||
native FileSize(const String:path[]);
|
native FileSize(const String:path[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Removes a directory.
|
* Removes a directory.
|
||||||
* @note On most Operating Systems you cannot remove a directory which has files inside it.
|
* @note On most Operating Systems you cannot remove a directory which has files inside it.
|
||||||
*
|
*
|
||||||
* @param path Path to the directory.
|
* @param path Path to the directory.
|
||||||
@ -178,7 +178,7 @@ native FileSize(const String:path[]);
|
|||||||
native bool:RemoveDir(const String:path[]);
|
native bool:RemoveDir(const String:path[]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Writes a line of text in a file.
|
* Writes a line of text in a file.
|
||||||
* @note This native will append the newline character.
|
* @note This native will append the newline character.
|
||||||
*
|
*
|
||||||
* @param hndl Handle to the file.
|
* @param hndl Handle to the file.
|
||||||
|
@ -27,7 +27,7 @@ enum Handle
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Returns if a handle is valid or not.
|
* Returns if a handle is valid or not.
|
||||||
* @note It is not a good idea to call this on every Handle. If you code properly,
|
* @note It is not a good idea to call this on every Handle. If you code properly,
|
||||||
* all of your Handles will either be valid or will expose important bugs to fix.
|
* all of your Handles will either be valid or will expose important bugs to fix.
|
||||||
* This is provided for situations only where testing for handle validity is needed.
|
* This is provided for situations only where testing for handle validity is needed.
|
||||||
@ -38,7 +38,7 @@ enum Handle
|
|||||||
native bool:IsValidHandle(Handle:hndl);
|
native bool:IsValidHandle(Handle:hndl);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Closes a Handle. If the handle has multiple copies open,
|
* Closes a Handle. If the handle has multiple copies open,
|
||||||
* it is not destroyed unless all copies are closed.
|
* it is not destroyed unless all copies are closed.
|
||||||
*
|
*
|
||||||
* @note Closing a Handle has a different meaning for each Handle type. Make
|
* @note Closing a Handle has a different meaning for each Handle type. Make
|
||||||
@ -51,7 +51,7 @@ native bool:IsValidHandle(Handle:hndl);
|
|||||||
native bool:CloseHandle(Handle:hndl);
|
native bool:CloseHandle(Handle:hndl);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Clones a Handle. When passing handles in between plugins, caching handles
|
* Clones a Handle. When passing handles in between plugins, caching handles
|
||||||
* can result in accidental invalidation when one plugin releases the Handle, or is its owner
|
* can result in accidental invalidation when one plugin releases the Handle, or is its owner
|
||||||
* is unloaded from memory. To prevent this, the Handle may be "cloned" with a new owner.
|
* is unloaded from memory. To prevent this, the Handle may be "cloned" with a new owner.
|
||||||
*
|
*
|
||||||
|
@ -21,7 +21,7 @@
|
|||||||
#define LANG_SERVER 0 /**< Translate using the server's language */
|
#define LANG_SERVER 0 /**< Translate using the server's language */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Loads a translation file for the plugin calling this native.
|
* Loads a translation file for the plugin calling this native.
|
||||||
*
|
*
|
||||||
* @param path Translation file.
|
* @param path Translation file.
|
||||||
* @noreturn
|
* @noreturn
|
||||||
|
@ -90,7 +90,7 @@ native Handle:StartMessageEx(UserMsg:msg, clients[], numClients, flags=0);
|
|||||||
native EndMessage();
|
native EndMessage();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Called when a message is hooked
|
* Called when a message is hooked
|
||||||
*
|
*
|
||||||
* @param msg_id Message index.
|
* @param msg_id Message index.
|
||||||
* @param bf Handle to the input bit buffer of the message.
|
* @param bf Handle to the input bit buffer of the message.
|
||||||
@ -104,14 +104,14 @@ native EndMessage();
|
|||||||
functag MsgHook Action:public(UserMsg:msg_id, Handle:bf, const players[], playersNum, bool:reliable, bool:init);
|
functag MsgHook Action:public(UserMsg:msg_id, Handle:bf, const players[], playersNum, bool:reliable, bool:init);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Called when a message is finished sending.
|
* Called when a message is finished sending.
|
||||||
*
|
*
|
||||||
* @param msg_id Message index.
|
* @param msg_id Message index.
|
||||||
*/
|
*/
|
||||||
functag MsgSentNotify public(UserMsg:msg_id);
|
functag MsgSentNotify public(UserMsg:msg_id);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Hooks a user message.
|
* Hooks a user message.
|
||||||
*
|
*
|
||||||
* @param msg_id Message index.
|
* @param msg_id Message index.
|
||||||
* @param hook Function to use as a hook.
|
* @param hook Function to use as a hook.
|
||||||
@ -125,7 +125,7 @@ functag MsgSentNotify public(UserMsg:msg_id);
|
|||||||
native HookUserMessage(UserMsg:msg_id, MsgHook:hook, bool:intercept=false, MsgSentNotify:notify=MsgSentNotify:-1);
|
native HookUserMessage(UserMsg:msg_id, MsgHook:hook, bool:intercept=false, MsgSentNotify:notify=MsgSentNotify:-1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Removes one usermessage hook.
|
* Removes one usermessage hook.
|
||||||
*
|
*
|
||||||
* @param msg_id Message index.
|
* @param msg_id Message index.
|
||||||
* @param hook Function used for the hook.
|
* @param hook Function used for the hook.
|
||||||
|
Loading…
Reference in New Issue
Block a user