From 0e167ee85b9ea4a756873bae5d01e6168f8c4e9d Mon Sep 17 00:00:00 2001 From: Erik Minekus Date: Thu, 1 Aug 2013 09:26:34 -0400 Subject: [PATCH] Numerous code documentation fixups (bug 5720, r=psychonic). --- plugins/include/admin.inc | 16 ++--- plugins/include/adt_array.inc | 4 +- plugins/include/adt_trie.inc | 2 +- plugins/include/clientprefs.inc | 5 +- plugins/include/clients.inc | 4 +- plugins/include/console.inc | 8 +-- plugins/include/cstrike.inc | 38 +++++------ plugins/include/dbi.inc | 9 ++- plugins/include/entity.inc | 6 +- plugins/include/entity_prop_stocks.inc | 72 ++++++++++---------- plugins/include/events.inc | 2 +- plugins/include/geoip.inc | 4 +- plugins/include/halflife.inc | 4 +- plugins/include/keyvalues.inc | 2 +- plugins/include/lang.inc | 2 +- plugins/include/menus.inc | 8 ++- plugins/include/protobuf.inc | 72 ++++++++++---------- plugins/include/regex.inc | 2 +- plugins/include/sdkhooks.inc | 68 +++++++++--------- plugins/include/sdktools_entinput.inc | 2 +- plugins/include/sdktools_functions.inc | 8 +-- plugins/include/sdktools_gamerules.inc | 5 ++ plugins/include/sdktools_sound.inc | 2 +- plugins/include/sdktools_stringtables.inc | 12 ++-- plugins/include/sdktools_tempents_stocks.inc | 12 ++-- plugins/include/sdktools_voice.inc | 3 +- plugins/include/sorting.inc | 2 +- plugins/include/sourcemod.inc | 4 +- plugins/include/string.inc | 14 ++-- plugins/include/tf2.inc | 27 ++++---- plugins/include/tf2_stocks.inc | 1 + plugins/include/timers.inc | 1 + plugins/include/topmenus.inc | 2 +- plugins/include/usermessages.inc | 2 +- 34 files changed, 221 insertions(+), 204 deletions(-) diff --git a/plugins/include/admin.inc b/plugins/include/admin.inc index cbeb3fc7..b126ceed 100644 --- a/plugins/include/admin.inc +++ b/plugins/include/admin.inc @@ -138,7 +138,7 @@ enum ImmunityType */ enum GroupId { - INVALID_GROUP_ID = -1, /**< An invalid/nonexistant group */ + INVALID_GROUP_ID = -1, /**< An invalid/non-existent group */ }; /** @@ -146,7 +146,7 @@ enum GroupId */ enum AdminId { - INVALID_ADMIN_ID = -1, /**< An invalid/nonexistant admin */ + INVALID_ADMIN_ID = -1, /**< An invalid/non-existent admin */ }; /** @@ -169,7 +169,7 @@ enum AdminCachePart }; /** - * Called when part of the cache which needs to be rebuilt. + * Called when part of the cache needs to be rebuilt. * * @param part Part of the admin cache to rebuild. */ @@ -324,7 +324,7 @@ native bool:GetAdmGroupCmdOverride(GroupId:id, const String:name[], OverrideType * Registers an authentication identity type. You normally never need to call this except for * very specific systems. * - * @param codename Codename to use for your authentication type. + * @param name Codename to use for your authentication type. * @noreturn */ native RegisterAuthIdentType(const String:name[]); @@ -425,7 +425,7 @@ native GroupId:GetAdminGroup(AdminId:id, index, const String:name[], maxlength); * Sets a password on an admin. * * @param id AdminId index of the admin. - * @param passwd String containing the password. + * @param password String containing the password. * @noreturn */ native SetAdminPassword(AdminId:id, const String:password[]); @@ -434,12 +434,12 @@ native SetAdminPassword(AdminId:id, const String:password[]); * Gets an admin's password. * * @param id AdminId index of the admin. - * @param name Optional buffer to store the admin's password. + * @param buffer Optional buffer to store the admin's password. * @param maxlength Maximum size of the output name buffer. * Note: This will safely chop UTF-8 strings. * @return True if there was a password set, false otherwise. */ -native bool:GetAdminPassword(AdminId:id, const String:buffer[]="", maxlength=0); +native bool:GetAdminPassword(AdminId:id, String:buffer[]="", maxlength=0); /** * Attempts to find an admin by an auth method and an identity. @@ -537,7 +537,7 @@ native ReadFlagString(const String:flags[], &numchars=0); /** * Tests whether one admin can target another. * - * The hueristics for this check are as follows: + * The heuristics for this check are as follows: * 0. If the targeting AdminId is INVALID_ADMIN_ID, targeting fails. * 1. If the targeted AdminId is INVALID_ADMIN_ID, targeting succeeds. * 2. If the targeted AdminId is the same as the targeting AdminId, diff --git a/plugins/include/adt_array.inc b/plugins/include/adt_array.inc index 0e226ab2..48d43be6 100644 --- a/plugins/include/adt_array.inc +++ b/plugins/include/adt_array.inc @@ -210,14 +210,14 @@ native SetArrayCell(Handle:array, index, any:value, block=0, bool:asChar=false); * @return Number of characters copied. * @error Invalid Handle or invalid index. */ -native SetArrayString(Handle:array, index, const String:buffer[]); +native SetArrayString(Handle:array, index, const String:value[]); /** * Sets an array of cells in an array. * * @param array Array Handle. * @param index Index in the array. - * @param buffer Array to copy. + * @param values Array to copy. * @param size If not set, assumes the buffer size is equal to the * blocksize. Otherwise, the size passed is used. * @return Number of cells copied. diff --git a/plugins/include/adt_trie.inc b/plugins/include/adt_trie.inc index acda5fc1..1f588f67 100644 --- a/plugins/include/adt_trie.inc +++ b/plugins/include/adt_trie.inc @@ -91,7 +91,7 @@ native bool:SetTrieString(Handle:trie, const String:key[], const String:value[], * * @param trie Trie Handle. * @param key Key string. - * @param val Variable to store value. + * @param value Variable to store value. * @return True on success. False if the key is not set, or the key is set * as an array or string (not a value). * @error Invalid Handle. diff --git a/plugins/include/clientprefs.inc b/plugins/include/clientprefs.inc index ffb7030b..fab19ccc 100644 --- a/plugins/include/clientprefs.inc +++ b/plugins/include/clientprefs.inc @@ -162,8 +162,8 @@ forward OnClientCookiesCached(client); * Cookie Menu Callback prototype * * @param client Client index. - * @param action CookeMenuAction being performed. - * @param data Info data passed. + * @param action CookieMenuAction being performed. + * @param info Info data passed. * @param buffer Outbut buffer. * @param maxlen Max length of the output buffer. */ @@ -221,7 +221,6 @@ native Handle:GetCookieIterator(); * @param access Access level of the cookie. * @param desc Cookie description buffer. * @param descLen Cookie description buffer size. - * @param * @return True on success, false if there are no more commands. */ native bool:ReadCookieIterator(Handle:iter, diff --git a/plugins/include/clients.inc b/plugins/include/clients.inc index 74d6aa7f..111da2f7 100644 --- a/plugins/include/clients.inc +++ b/plugins/include/clients.inc @@ -247,7 +247,7 @@ native bool:GetClientName(client, String:name[], maxlen); * Retrieves a client's IP address. * * @param client Player index. - * @param name Buffer to store the client's ip address. + * @param ip Buffer to store the client's ip address. * @param maxlen Maximum length of string buffer (includes NULL terminator). * @param remport Remove client's port from the ip string (true by default). * @return True on success, false otherwise. @@ -763,6 +763,7 @@ native ChangeClientTeam(client, team); /** * Returns the clients unique serial identifier. * + * @param client Client index. * @return Serial number. */ native GetClientSerial(client); @@ -770,6 +771,7 @@ native GetClientSerial(client); /** * Returns the client index by its serial number. * + * @param serial Serial number. * @return Client index, or 0 for invalid serial. */ native GetClientFromSerial(serial); diff --git a/plugins/include/console.inc b/plugins/include/console.inc index 84524e57..a0af53dd 100644 --- a/plugins/include/console.inc +++ b/plugins/include/console.inc @@ -160,7 +160,7 @@ native ServerExecute(); * * @param client Index of the client. * @param fmt Format of the client command. - * @param ... Format parameters/ + * @param ... Format parameters * @noreturn * @error Invalid client index, or client not connected. */ @@ -324,7 +324,7 @@ native FormatActivitySource(client, target, const String:namebuf[], maxlength); /** * Called when a server-only command is invoked. * - * @params args Number of arguments that were in the argument string. + * @param args Number of arguments that were in the argument string. * @return An Action value. Not handling the command * means that Source will report it as "not found." */ @@ -358,7 +358,7 @@ functag public Action:ConCmd(client, args); * Creates a console command, or hooks an already existing one. * * Console commands are case sensitive. However, if the command already exists in the game, - * the a client may enter the command in any case. SourceMod corrects for this automatically, + * a client may enter the command in any case. SourceMod corrects for this automatically, * and you should only hook the "real" version of the command. * * @param cmd Name of the command to hook or create. @@ -703,7 +703,7 @@ funcenum ConVarQueryFinished * Starts a query to retrieve the value of a client's console variable. * * @param client Player index. - * @param name Name of client convar to query. + * @param cvarName Name of client convar to query. * @param callback A function to use as a callback when the query has finished. * @param value Optional value to pass to the callback function. * @return A cookie that uniquely identifies the query. diff --git a/plugins/include/cstrike.inc b/plugins/include/cstrike.inc index b07a3134..7ef94e41 100644 --- a/plugins/include/cstrike.inc +++ b/plugins/include/cstrike.inc @@ -47,26 +47,26 @@ enum CSRoundEndReason { - CSRoundEnd_TargetBombed = 0, // Target Successfully Bombed! - CSRoundEnd_VIPEscaped, // The VIP has escaped! - CSRoundEnd_VIPKilled, // VIP has been assassinated! - CSRoundEnd_TerroristsEscaped, // The terrorists have escaped! - CSRoundEnd_CTStoppedEscape, // The CTs have prevented most of the terrorists from escaping! - CSRoundEnd_TerroristsStopped, // Escaping terrorists have all been neutralized! - CSRoundEnd_BombDefused, // The bomb has been defused! - CSRoundEnd_CTWin, // Counter-Terrorists Win! - CSRoundEnd_TerroristWin, // Terrorists Win! - CSRoundEnd_Draw, // Round Draw! - CSRoundEnd_HostagesRescued, // All Hostages have been rescued! - CSRoundEnd_TargetSaved, // Target has been saved! - CSRoundEnd_HostagesNotRescued, // Hostages have not been rescued! - CSRoundEnd_TerroristsNotEscaped, // Terrorists have not escaped! - CSRoundEnd_VIPNotEscaped, // VIP has not escaped! - CSRoundEnd_GameStart, // Game Commencing! + CSRoundEnd_TargetBombed = 0, /**< Target Successfully Bombed! */ + CSRoundEnd_VIPEscaped, /**< The VIP has escaped! */ + CSRoundEnd_VIPKilled, /**< VIP has been assassinated! */ + CSRoundEnd_TerroristsEscaped, /**< The terrorists have escaped! */ + CSRoundEnd_CTStoppedEscape, /**< The CTs have prevented most of the terrorists from escaping! */ + CSRoundEnd_TerroristsStopped, /**< Escaping terrorists have all been neutralized! */ + CSRoundEnd_BombDefused, /**< The bomb has been defused! */ + CSRoundEnd_CTWin, /**< Counter-Terrorists Win! */ + CSRoundEnd_TerroristWin, /**< Terrorists Win! */ + CSRoundEnd_Draw, /**< Round Draw! */ + CSRoundEnd_HostagesRescued, /**< All Hostages have been rescued! */ + CSRoundEnd_TargetSaved, /**< Target has been saved! */ + CSRoundEnd_HostagesNotRescued, /**< Hostages have not been rescued! */ + CSRoundEnd_TerroristsNotEscaped, /**< Terrorists have not escaped! */ + CSRoundEnd_VIPNotEscaped, /**< VIP has not escaped! */ + CSRoundEnd_GameStart, /**< Game Commencing! */ // The below only exist on CS:GO - CSRoundEnd_TerroristsSurrender, // Terrorists Surrender - CSRoundEnd_CTSurrender, // CTs Surrender + CSRoundEnd_TerroristsSurrender, /**< Terrorists Surrender */ + CSRoundEnd_CTSurrender, /**< CTs Surrender */ }; enum CSWeaponID @@ -144,7 +144,7 @@ forward Action:CS_OnBuyCommand(client, const String:weapon[]); * higher action to deny. * * @param client Client index - * @param weapon Weapon index + * @param weaponIndex Weapon index */ forward Action:CS_OnCSWeaponDrop(client, weaponIndex); diff --git a/plugins/include/dbi.inc b/plugins/include/dbi.inc index 4cb12e2c..705c20e9 100644 --- a/plugins/include/dbi.inc +++ b/plugins/include/dbi.inc @@ -137,6 +137,8 @@ stock Handle:SQL_DefConnect(String:error[], maxlength, bool:persistent=true) * @param keyvalues Key/value pairs from a KeyValues handle, describing the connection. * @param error Error buffer. * @param maxlength Maximum length of the error buffer. + * @param persistent True to re-use a previous persistent connection if + * possible, false otherwise. * @return A database connection Handle, or INVALID_HANDLE on failure. * On failure the error buffer will be filled with a message. * @error Invalid KeyValues handle. @@ -304,7 +306,7 @@ native bool:SQL_GetError(Handle:hndl, String:error[], maxlength); * encloses the string in ''. While drivers tend to allow " instead, the string * may be not be escaped (for example, on SQLite)! * - * @param hndl A database Handle. + * @param database A database Handle. * @param string String to quote. * @param buffer Buffer to store quoted string in. * @param maxlength Maximum length of the buffer. @@ -569,7 +571,7 @@ native SQL_BindParamInt(Handle:statement, param, number, bool:signed=true); * * @param statement A statement (prepared query) Handle. * @param param The parameter index (starting from 0). - * @param float The float number to bind. + * @param value The float number to bind. * @noreturn * @error Invalid statement Handle or parameter index, or * SQL error. @@ -633,7 +635,7 @@ native SQL_UnlockDatabase(Handle:database); /** * General callback for threaded SQL stuff. * - * @param db Parent object of the Handle (or INVALID_HANDLE if none). + * @param owner Parent object of the Handle (or INVALID_HANDLE if none). * @param hndl Handle to the child object (or INVALID_HANDLE if none). * @param error Error string if there was an error. The error could be * empty even if an error condition exists, so it is important @@ -666,6 +668,7 @@ native bool:SQL_IsSameConnection(Handle:hndl1, Handle:hndl2); * @param callback Callback; new Handle will be in hndl, owner is the driver. * If no driver was found, the owner is INVALID_HANDLE. * @param name Database name. + * @param data Extra data value to pass to the callback. * @noreturn */ native SQL_TConnect(SQLTCallback:callback, const String:name[]="default", any:data=0); diff --git a/plugins/include/entity.inc b/plugins/include/entity.inc index 2a5e5703..950ef07e 100644 --- a/plugins/include/entity.inc +++ b/plugins/include/entity.inc @@ -226,6 +226,7 @@ native GetEntData(entity, offset, size=4); * * @param entity Edict index. * @param offset Offset to use. + * @param value Value to set. * @param size Number of bytes to write (valid values are 1, 2, or 4). * @param changeState If true, change will be sent over the network. * @return Value at the given memory location. @@ -251,6 +252,7 @@ native Float:GetEntDataFloat(entity, offset); * * @param entity Edict index. * @param offset Offset to use. + * @param value Value to set. * @param changeState If true, change will be sent over the network. * @return Value at the given memory location. * @error Invalid entity or offset out of reasonable bounds. @@ -281,7 +283,7 @@ native GetEntDataEnt(entity, offset); * reasons explained in the notes. * * Note: This function uses 0 as an indicator to unset data, but - * 0 is also the world entity index. Thus, the a property cannot + * 0 is also the world entity index. Thus, a property cannot * be set to the world entity using this native. * * @param entity Edict index. @@ -705,7 +707,7 @@ native Address:GetEntityAddress(entity); * This is like GetEdictClassname(), except it works for ALL * entities, not just edicts. * - * @param edict Index of the entity. + * @param entity Index of the entity. * @param clsname Buffer to store the classname. * @param maxlength Maximum length of the buffer. * @return True on success, false if there is no classname set. diff --git a/plugins/include/entity_prop_stocks.inc b/plugins/include/entity_prop_stocks.inc index 3d23c73c..9e9b046d 100644 --- a/plugins/include/entity_prop_stocks.inc +++ b/plugins/include/entity_prop_stocks.inc @@ -113,56 +113,56 @@ enum RenderFx #define IN_RELOAD (1 << 13) #define IN_ALT1 (1 << 14) #define IN_ALT2 (1 << 15) -#define IN_SCORE (1 << 16) // Used by client.dll for when scoreboard is held down -#define IN_SPEED (1 << 17) // Player is holding the speed key -#define IN_WALK (1 << 18) // Player holding walk key -#define IN_ZOOM (1 << 19) // Zoom key for HUD zoom -#define IN_WEAPON1 (1 << 20) // weapon defines these bits -#define IN_WEAPON2 (1 << 21) // weapon defines these bits +#define IN_SCORE (1 << 16) /**< Used by client.dll for when scoreboard is held down */ +#define IN_SPEED (1 << 17) /**< Player is holding the speed key */ +#define IN_WALK (1 << 18) /**< Player holding walk key */ +#define IN_ZOOM (1 << 19) /**< Zoom key for HUD zoom */ +#define IN_WEAPON1 (1 << 20) /**< weapon defines these bits */ +#define IN_WEAPON2 (1 << 21) /**< weapon defines these bits */ #define IN_BULLRUSH (1 << 22) -#define IN_GRENADE1 (1 << 23) // grenade 1 -#define IN_GRENADE2 (1 << 24) // grenade 2 +#define IN_GRENADE1 (1 << 23) /**< grenade 1 */ +#define IN_GRENADE2 (1 << 24) /**< grenade 2 */ #define IN_ATTACK3 (1 << 25) // Note: these are only for use with GetEntityFlags and SetEntityFlags // and may not match the game's actual, internal m_fFlags values. // PLAYER SPECIFIC FLAGS FIRST BECAUSE WE USE ONLY A FEW BITS OF NETWORK PRECISION -#define FL_ONGROUND (1 << 0) // At rest / on the ground -#define FL_DUCKING (1 << 1) // Player flag -- Player is fully crouched -#define FL_WATERJUMP (1 << 2) // player jumping out of water -#define FL_ONTRAIN (1 << 3) // Player is _controlling_ a train, so movement commands should be ignored on client during prediction. -#define FL_INRAIN (1 << 4) // Indicates the entity is standing in rain -#define FL_FROZEN (1 << 5) // Player is frozen for 3rd person camera -#define FL_ATCONTROLS (1 << 6) // Player can't move, but keeps key inputs for controlling another entity -#define FL_CLIENT (1 << 7) // Is a player -#define FL_FAKECLIENT (1 << 8) // Fake client, simulated server side; don't send network messages to them +#define FL_ONGROUND (1 << 0) /**< At rest / on the ground */ +#define FL_DUCKING (1 << 1) /**< Player flag -- Player is fully crouched */ +#define FL_WATERJUMP (1 << 2) /**< player jumping out of water */ +#define FL_ONTRAIN (1 << 3) /**< Player is _controlling_ a train, so movement commands should be ignored on client during prediction. */ +#define FL_INRAIN (1 << 4) /**< Indicates the entity is standing in rain */ +#define FL_FROZEN (1 << 5) /**< Player is frozen for 3rd person camera */ +#define FL_ATCONTROLS (1 << 6) /**< Player can't move, but keeps key inputs for controlling another entity */ +#define FL_CLIENT (1 << 7) /**< Is a player */ +#define FL_FAKECLIENT (1 << 8) /**< Fake client, simulated server side; don't send network messages to them */ // NOTE if you move things up, make sure to change this value #define PLAYER_FLAG_BITS 9 // NON-PLAYER SPECIFIC (i.e., not used by GameMovement or the client .dll ) -- Can still be applied to players, though -#define FL_INWATER (1 << 9) // In water -#define FL_FLY (1 << 10) // Changes the SV_Movestep() behavior to not need to be on ground -#define FL_SWIM (1 << 11) // Changes the SV_Movestep() behavior to not need to be on ground (but stay in water) +#define FL_INWATER (1 << 9) /**< In water */ +#define FL_FLY (1 << 10) /**< Changes the SV_Movestep() behavior to not need to be on ground */ +#define FL_SWIM (1 << 11) /**< Changes the SV_Movestep() behavior to not need to be on ground (but stay in water) */ #define FL_CONVEYOR (1 << 12) #define FL_NPC (1 << 13) #define FL_GODMODE (1 << 14) #define FL_NOTARGET (1 << 15) -#define FL_AIMTARGET (1 << 16) // set if the crosshair needs to aim onto the entity -#define FL_PARTIALGROUND (1 << 17) // not all corners are valid -#define FL_STATICPROP (1 << 18) // Eetsa static prop! -#define FL_GRAPHED (1 << 19) // worldgraph has this ent listed as something that blocks a connection +#define FL_AIMTARGET (1 << 16) /**< set if the crosshair needs to aim onto the entity */ +#define FL_PARTIALGROUND (1 << 17) /**< not all corners are valid */ +#define FL_STATICPROP (1 << 18) /**< Eetsa static prop! */ +#define FL_GRAPHED (1 << 19) /**< worldgraph has this ent listed as something that blocks a connection */ #define FL_GRENADE (1 << 20) -#define FL_STEPMOVEMENT (1 << 21) // Changes the SV_Movestep() behavior to not do any processing -#define FL_DONTTOUCH (1 << 22) // Doesn't generate touch functions, generates Untouch() for anything it was touching when this flag was set -#define FL_BASEVELOCITY (1 << 23) // Base velocity has been applied this frame (used to convert base velocity into momentum) -#define FL_WORLDBRUSH (1 << 24) // Not moveable/removeable brush entity (really part of the world, but represented as an entity for transparency or something) -#define FL_OBJECT (1 << 25) // Terrible name. This is an object that NPCs should see. Missiles, for example. -#define FL_KILLME (1 << 26) // This entity is marked for death -- will be freed by game DLL -#define FL_ONFIRE (1 << 27) // You know... -#define FL_DISSOLVING (1 << 28) // We're dissolving! -#define FL_TRANSRAGDOLL (1 << 29) // In the process of turning into a client side ragdoll. -#define FL_UNBLOCKABLE_BY_PLAYER (1 << 30) // pusher that can't be blocked by the player -#define FL_FREEZING (1 << 31) // We're becoming frozen! -#define FL_EP2V_UNKNOWN1 (1 << 31) // Unknown +#define FL_STEPMOVEMENT (1 << 21) /**< Changes the SV_Movestep() behavior to not do any processing */ +#define FL_DONTTOUCH (1 << 22) /**< Doesn't generate touch functions, generates Untouch() for anything it was touching when this flag was set */ +#define FL_BASEVELOCITY (1 << 23) /**< Base velocity has been applied this frame (used to convert base velocity into momentum) */ +#define FL_WORLDBRUSH (1 << 24) /**< Not moveable/removeable brush entity (really part of the world, but represented as an entity for transparency or something) */ +#define FL_OBJECT (1 << 25) /**< Terrible name. This is an object that NPCs should see. Missiles, for example. */ +#define FL_KILLME (1 << 26) /**< This entity is marked for death -- will be freed by game DLL */ +#define FL_ONFIRE (1 << 27) /**< You know... */ +#define FL_DISSOLVING (1 << 28) /**< We're dissolving! */ +#define FL_TRANSRAGDOLL (1 << 29) /**< In the process of turning into a client side ragdoll. */ +#define FL_UNBLOCKABLE_BY_PLAYER (1 << 30) /**< pusher that can't be blocked by the player */ +#define FL_FREEZING (1 << 31) /**< We're becoming frozen! */ +#define FL_EP2V_UNKNOWN1 (1 << 31) /**< Unknown */ // END entity flag #defines /** diff --git a/plugins/include/events.inc b/plugins/include/events.inc index 91bcbbc4..be3f2d46 100644 --- a/plugins/include/events.inc +++ b/plugins/include/events.inc @@ -235,7 +235,7 @@ native SetEventString(Handle:event, const String:key[], const String:value[]); * Retrieves the name of a game event. * * @param event Handle to the event. - * @param value Buffer to store the name of the event. + * @param name Buffer to store the name of the event. * @param maxlength Maximum length of string buffer. * @noreturn * @error Invalid or corrupt Handle. diff --git a/plugins/include/geoip.inc b/plugins/include/geoip.inc index 10f1fe5d..14ede1fb 100644 --- a/plugins/include/geoip.inc +++ b/plugins/include/geoip.inc @@ -63,8 +63,8 @@ native bool:GeoipCode3(const String:ip[], String:ccode[4]); * Gets the full country name. (max length of output string is 45) * * @param ip Ip to determine the country code. - * @param ccode Destination string buffer to store the country name. - * @param len Maximum length of output string buffer. + * @param name Destination string buffer to store the country name. + * @param maxlength Maximum length of output string buffer. * @return True on success, false if no country found. */ native bool:GeoipCountry(const String:ip[], String:name[], maxlength); diff --git a/plugins/include/halflife.inc b/plugins/include/halflife.inc index 99e4da08..a48dc488 100644 --- a/plugins/include/halflife.inc +++ b/plugins/include/halflife.inc @@ -126,7 +126,7 @@ native GetRandomInt(nmin, nmax); /** * Returns whether a map is valid or not. * - * @param Map name, excluding .bsp extension. + * @param map Map name, excluding .bsp extension. * @return True if valid, false otherwise. */ native bool:IsMapValid(const String:map[]); @@ -244,7 +244,7 @@ native bool:IsDecalPrecached(const String:decal[]); /** * Returns if a given generic file is precached. * - * @param decal Name of the generic file to check. + * @param generic Name of the generic file to check. * @return True if precached, false otherwise. */ native bool:IsGenericPrecached(const String:generic[]); diff --git a/plugins/include/keyvalues.inc b/plugins/include/keyvalues.inc index a83f052b..c607d7d3 100644 --- a/plugins/include/keyvalues.inc +++ b/plugins/include/keyvalues.inc @@ -60,7 +60,7 @@ enum KvDataTypes * @param firstValue If firstKey is non-empty, specifies the first key's value. * @return A Handle to a new KeyValues structure. */ -native Handle:CreateKeyValues(const String:name[], const String:firstkey[]="", const String:firstValue[]=""); +native Handle:CreateKeyValues(const String:name[], const String:firstKey[]="", const String:firstValue[]=""); /** * Sets a string value of a KeyValues key. diff --git a/plugins/include/lang.inc b/plugins/include/lang.inc index 1931a5f5..9728083a 100644 --- a/plugins/include/lang.inc +++ b/plugins/include/lang.inc @@ -41,7 +41,7 @@ * Loads a translation file for the plugin calling this native. * If no extension is specified, .txt is assumed. * - * @param path Translation file. + * @param file Translation file. * @noreturn */ native LoadTranslations(const String:file[]); diff --git a/plugins/include/menus.inc b/plugins/include/menus.inc index 2288b59d..0b3bf50a 100644 --- a/plugins/include/menus.inc +++ b/plugins/include/menus.inc @@ -345,6 +345,7 @@ native GetMenuTitle(Handle:menu, String:buffer[], maxlength); * Creates a raw MenuPanel based off the menu's style. * The Handle must be freed with CloseHandle(). * + * @param menu Menu Handle. * @return A new MenuPanel Handle. * @error Invalid Handle. */ @@ -600,7 +601,7 @@ native Handle:CreatePanel(Handle:hStyle=INVALID_HANDLE); * Creates a Menu from a MenuStyle. The Handle must be closed with * CloseHandle(). * - * @parma hStyle MenuStyle Handle, or INVALID_HANDLE to use the default style. + * @param hStyle MenuStyle Handle, or INVALID_HANDLE to use the default style. * @param handler Function which will receive menu actions. * @param actions Optionally set which actions to receive. Select, * Cancel, and End will always be received regardless @@ -624,7 +625,7 @@ native MenuSource:GetClientMenu(client, Handle:hStyle=INVALID_HANDLE); /** * Cancels a menu on a client. This will only affect non-external menus. * - * @param hstyle MenuStyle Handle, or INVALID_HANDLE to use the default style. + * @param hStyle MenuStyle Handle, or INVALID_HANDLE to use the default style. * @param client Client index. * @param autoIgnore If true, no menus can be re-drawn on the client during * the cancellation process. @@ -654,7 +655,7 @@ native Handle:GetPanelStyle(Handle:panel); * Sets the panel's title. * * @param panel A MenuPanel Handle. - * @param title Text to set as the title. + * @param text Text to set as the title. * @param onlyIfEmpty If true, the title will only be set if no title is set. * @noreturn * @error Invalid Handle. @@ -701,6 +702,7 @@ native CanPanelDrawFlags(Handle:panel, style); * Sets the selectable key map of a panel. This is not supported by * all styles (only by Radio, as of this writing). * + * @param panel A MenuPanel Handle. * @param keys An integer where each bit N allows key * N+1 to be selected. If no keys are selectable, * then key 0 (bit 9) is automatically set. diff --git a/plugins/include/protobuf.inc b/plugins/include/protobuf.inc index 56ffb6ed..ced88975 100644 --- a/plugins/include/protobuf.inc +++ b/plugins/include/protobuf.inc @@ -44,7 +44,7 @@ * @param field Field name. * @param index Index into repeated field. * @return Integer value read. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbReadInt(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED); @@ -55,7 +55,7 @@ native PbReadInt(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED); * @param field Field name. * @param index Index into repeated field. * @return Float value read. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native Float:PbReadFloat(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED); @@ -66,7 +66,7 @@ native Float:PbReadFloat(Handle:pb, const String:field[], index=PB_FIELD_NOT_REP * @param field Field name. * @param index Index into repeated field. * @return Boolean value read. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native bool:PbReadBool(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEATED); @@ -79,7 +79,7 @@ native bool:PbReadBool(Handle:pb, const String:field[], index=PB_FIELD_NOT_REPEA * @param maxlength Maximum length of output string buffer. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbReadString(Handle:pb, const String:field[], String:buffer[], maxlength, index=PB_FIELD_NOT_REPEATED); @@ -91,7 +91,7 @@ native PbReadString(Handle:pb, const String:field[], String:buffer[], maxlength, * @param buffer Destination color buffer. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbReadColor(Handle:pb, const String:field[], buffer[4], index=PB_FIELD_NOT_REPEATED); @@ -103,7 +103,7 @@ native PbReadColor(Handle:pb, const String:field[], buffer[4], index=PB_FIELD_NO * @param buffer Destination angle buffer. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbReadAngle(Handle:pb, const String:field[], Float:buffer[3], index=PB_FIELD_NOT_REPEATED); @@ -115,7 +115,7 @@ native PbReadAngle(Handle:pb, const String:field[], Float:buffer[3], index=PB_FI * @param buffer Destination vector buffer. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbReadVector(Handle:pb, const String:field[], Float:buffer[3], index=PB_FIELD_NOT_REPEATED); @@ -127,7 +127,7 @@ native PbReadVector(Handle:pb, const String:field[], Float:buffer[3], index=PB_F * @param buffer Destination vector buffer. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbReadVector2D(Handle:pb, const String:field[], Float:buffer[2], index=PB_FIELD_NOT_REPEATED); @@ -137,7 +137,7 @@ native PbReadVector2D(Handle:pb, const String:field[], Float:buffer[2], index=PB * @param pb protobuf handle. * @param field Field name. * @return Number of elements in the field. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbGetRepeatedFieldCount(Handle:pb, const String:field[]); @@ -149,7 +149,7 @@ native PbGetRepeatedFieldCount(Handle:pb, const String:field[]); * @param value Integer value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetInt(Handle:pb, const String:field[], value, index=PB_FIELD_NOT_REPEATED); @@ -161,7 +161,7 @@ native PbSetInt(Handle:pb, const String:field[], value, index=PB_FIELD_NOT_REPEA * @param value Float value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetFloat(Handle:pb, const String:field[], Float:value, index=PB_FIELD_NOT_REPEATED); @@ -173,7 +173,7 @@ native PbSetFloat(Handle:pb, const String:field[], Float:value, index=PB_FIELD_N * @param value Boolean value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetBool(Handle:pb, const String:field[], bool:value, index=PB_FIELD_NOT_REPEATED); @@ -185,7 +185,7 @@ native PbSetBool(Handle:pb, const String:field[], bool:value, index=PB_FIELD_NOT * @param value String value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetString(Handle:pb, const String:field[], const String:value[], index=PB_FIELD_NOT_REPEATED); @@ -194,10 +194,10 @@ native PbSetString(Handle:pb, const String:field[], const String:value[], index= * * @param pb protobuf handle. * @param field Field name. - * @param value Color value to set. + * @param color Color value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetColor(Handle:pb, const String:field[], const color[4], index=PB_FIELD_NOT_REPEATED); @@ -206,10 +206,10 @@ native PbSetColor(Handle:pb, const String:field[], const color[4], index=PB_FIEL * * @param pb protobuf handle. * @param field Field name. - * @param value Angle value to set. + * @param angle Angle value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetAngle(Handle:pb, const String:field[], const Float:angle[3], index=PB_FIELD_NOT_REPEATED); @@ -218,10 +218,10 @@ native PbSetAngle(Handle:pb, const String:field[], const Float:angle[3], index=P * * @param pb protobuf handle. * @param field Field name. - * @param value Vector value to set. + * @param vec Vector value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetVector(Handle:pb, const String:field[], const Float:vec[3], index=PB_FIELD_NOT_REPEATED); @@ -230,10 +230,10 @@ native PbSetVector(Handle:pb, const String:field[], const Float:vec[3], index=PB * * @param pb protobuf handle. * @param field Field name. - * @param value Vector value to set. + * @param vec Vector value to set. * @param index Index into repeated field. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbSetVector2D(Handle:pb, const String:field[], const Float:vec[2], index=PB_FIELD_NOT_REPEATED); @@ -244,7 +244,7 @@ native PbSetVector2D(Handle:pb, const String:field[], const Float:vec[2], index= * @param field Field name. * @param value Integer value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddInt(Handle:pb, const String:field[], value); @@ -255,7 +255,7 @@ native PbAddInt(Handle:pb, const String:field[], value); * @param field Field name. * @param value Float value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddFloat(Handle:pb, const String:field[], Float:value); @@ -266,7 +266,7 @@ native PbAddFloat(Handle:pb, const String:field[], Float:value); * @param field Field name. * @param value Boolean value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddBool(Handle:pb, const String:field[], bool:value); @@ -277,7 +277,7 @@ native PbAddBool(Handle:pb, const String:field[], bool:value); * @param field Field name. * @param value String value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddString(Handle:pb, const String:field[], const String:value[]); @@ -286,9 +286,9 @@ native PbAddString(Handle:pb, const String:field[], const String:value[]); * * @param pb protobuf handle. * @param field Field name. - * @param value Color value to add. + * @param color Color value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddColor(Handle:pb, const String:field[], const color[4]); @@ -297,9 +297,9 @@ native PbAddColor(Handle:pb, const String:field[], const color[4]); * * @param pb protobuf handle. * @param field Field name. - * @param value Angle value to add. + * @param angle Angle value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddAngle(Handle:pb, const String:field[], const Float:angle[3]); @@ -308,9 +308,9 @@ native PbAddAngle(Handle:pb, const String:field[], const Float:angle[3]); * * @param pb protobuf handle. * @param field Field name. - * @param value Vector value to add. + * @param vec Vector value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddVector(Handle:pb, const String:field[], const Float:vec[3]); @@ -319,9 +319,9 @@ native PbAddVector(Handle:pb, const String:field[], const Float:vec[3]); * * @param pb protobuf handle. * @param field Field name. - * @param value Vector value to add. + * @param vec Vector value to add. * @noreturn - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native PbAddVector2D(Handle:pb, const String:field[], const Float:vec[2]); @@ -331,7 +331,7 @@ native PbAddVector2D(Handle:pb, const String:field[], const Float:vec[2]); * @param pb protobuf handle. * @param field Field name. * @return protobuf handle to embedded message. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native Handle:PbReadMessage(Handle:pb, const String:field[]); @@ -342,7 +342,7 @@ native Handle:PbReadMessage(Handle:pb, const String:field[]); * @param field Field name. * @param index Index in the repeated field. * @return protobuf handle to embedded message. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native Handle:PbReadRepeatedMessage(Handle:pb, const String:field[], index); @@ -352,6 +352,6 @@ native Handle:PbReadRepeatedMessage(Handle:pb, const String:field[], index); * @param pb protobuf handle. * @param field Field name. * @return protobuf handle to added, embedded message. - * @error Invalid or incorrect Handle, non-existant field, or incorrect field type. + * @error Invalid or incorrect Handle, non-existent field, or incorrect field type. */ native Handle:PbAddMessage(Handle:pb, const String:field[]); diff --git a/plugins/include/regex.inc b/plugins/include/regex.inc index 418f3d62..d045eae8 100644 --- a/plugins/include/regex.inc +++ b/plugins/include/regex.inc @@ -127,7 +127,7 @@ native MatchRegex(Handle:regex, const String:str[], &RegexError:ret = REGEX_ERRO * @param regex The regex handle to extract data from. * @param str_id The index of the expression to get - starts at 0, and ends at substrings - 1. * @param buffer The buffer to set to the matching substring. - * @param maxLen The maximum string length of the buffer. + * @param maxlen The maximum string length of the buffer. * @return True if a substring was found, False on fail/error */ native bool:GetRegexSubString(Handle:regex, str_id, String:buffer[], maxlen); diff --git a/plugins/include/sdkhooks.inc b/plugins/include/sdkhooks.inc index cb552447..2b255044 100644 --- a/plugins/include/sdkhooks.inc +++ b/plugins/include/sdkhooks.inc @@ -35,40 +35,40 @@ // this is obviously _not_ a robust check, but it will solve most conflict and is clean #if !defined DMG_GENERIC -#define DMG_GENERIC 0 // generic damage was done -#define DMG_CRUSH (1 << 0) // crushed by falling or moving object. - // NOTE: It's assumed crush damage is occurring as a result of physics collision, so no extra physics force is generated by crush damage. - // DON'T use DMG_CRUSH when damaging entities unless it's the result of a physics collision. You probably want DMG_CLUB instead. -#define DMG_BULLET (1 << 1) // shot -#define DMG_SLASH (1 << 2) // cut, clawed, stabbed -#define DMG_BURN (1 << 3) // heat burned -#define DMG_VEHICLE (1 << 4) // hit by a vehicle -#define DMG_FALL (1 << 5) // fell too far -#define DMG_BLAST (1 << 6) // explosive blast damage -#define DMG_CLUB (1 << 7) // crowbar, punch, headbutt -#define DMG_SHOCK (1 << 8) // electric shock -#define DMG_SONIC (1 << 9) // sound pulse shockwave -#define DMG_ENERGYBEAM (1 << 10) // laser or other high energy beam -#define DMG_PREVENT_PHYSICS_FORCE (1 << 11) // Prevent a physics force -#define DMG_NEVERGIB (1 << 12) // with this bit OR'd in, no damage type will be able to gib victims upon death -#define DMG_ALWAYSGIB (1 << 13) // with this bit OR'd in, any damage type can be made to gib victims upon death. -#define DMG_DROWN (1 << 14) // Drowning -#define DMG_PARALYZE (1 << 15) // slows affected creature down -#define DMG_NERVEGAS (1 << 16) // nerve toxins, very bad -#define DMG_POISON (1 << 17) // blood poisoning - heals over time like drowning damage -#define DMG_RADIATION (1 << 18) // radiation exposure -#define DMG_DROWNRECOVER (1 << 19) // drowning recovery -#define DMG_ACID (1 << 20) // toxic chemicals or acid burns -#define DMG_SLOWBURN (1 << 21) // in an oven -#define DMG_REMOVENORAGDOLL (1 << 22) // with this bit OR'd in, no ragdoll will be created, and the target will be quietly removed. - // use this to kill an entity that you've already got a server-side ragdoll for -#define DMG_PHYSGUN (1 << 23) // Hit by manipulator. Usually doesn't do any damage. -#define DMG_PLASMA (1 << 24) // Shot by Cremator -#define DMG_AIRBOAT (1 << 25) // Hit by the airboat's gun -#define DMG_DISSOLVE (1 << 26) // Dissolving! -#define DMG_BLAST_SURFACE (1 << 27) // A blast on the surface of water that cannot harm things underwater +#define DMG_GENERIC 0 /**< generic damage was done */ +#define DMG_CRUSH (1 << 0) /**< crushed by falling or moving object. + NOTE: It's assumed crush damage is occurring as a result of physics collision, so no extra physics force is generated by crush damage. + DON'T use DMG_CRUSH when damaging entities unless it's the result of a physics collision. You probably want DMG_CLUB instead. */ +#define DMG_BULLET (1 << 1) /**< shot */ +#define DMG_SLASH (1 << 2) /**< cut, clawed, stabbed */ +#define DMG_BURN (1 << 3) /**< heat burned */ +#define DMG_VEHICLE (1 << 4) /**< hit by a vehicle */ +#define DMG_FALL (1 << 5) /**< fell too far */ +#define DMG_BLAST (1 << 6) /**< explosive blast damage */ +#define DMG_CLUB (1 << 7) /**< crowbar, punch, headbutt */ +#define DMG_SHOCK (1 << 8) /**< electric shock */ +#define DMG_SONIC (1 << 9) /**< sound pulse shockwave */ +#define DMG_ENERGYBEAM (1 << 10) /**< laser or other high energy beam */ +#define DMG_PREVENT_PHYSICS_FORCE (1 << 11) /**< Prevent a physics force */ +#define DMG_NEVERGIB (1 << 12) /**< with this bit OR'd in, no damage type will be able to gib victims upon death */ +#define DMG_ALWAYSGIB (1 << 13) /**< with this bit OR'd in, any damage type can be made to gib victims upon death. */ +#define DMG_DROWN (1 << 14) /**< Drowning */ +#define DMG_PARALYZE (1 << 15) /**< slows affected creature down */ +#define DMG_NERVEGAS (1 << 16) /**< nerve toxins, very bad */ +#define DMG_POISON (1 << 17) /**< blood poisoning - heals over time like drowning damage */ +#define DMG_RADIATION (1 << 18) /**< radiation exposure */ +#define DMG_DROWNRECOVER (1 << 19) /**< drowning recovery */ +#define DMG_ACID (1 << 20) /**< toxic chemicals or acid burns */ +#define DMG_SLOWBURN (1 << 21) /**< in an oven */ +#define DMG_REMOVENORAGDOLL (1 << 22) /**< with this bit OR'd in, no ragdoll will be created, and the target will be quietly removed. + use this to kill an entity that you've already got a server-side ragdoll for */ +#define DMG_PHYSGUN (1 << 23) /**< Hit by manipulator. Usually doesn't do any damage. */ +#define DMG_PLASMA (1 << 24) /**< Shot by Cremator */ +#define DMG_AIRBOAT (1 << 25) /**< Hit by the airboat's gun */ +#define DMG_DISSOLVE (1 << 26) /**< Dissolving! */ +#define DMG_BLAST_SURFACE (1 << 27) /**< A blast on the surface of water that cannot harm things underwater */ #define DMG_DIRECT (1 << 28) -#define DMG_BUCKSHOT (1 << 29) // not quite a bullet. Little, rounder, different. +#define DMG_BUCKSHOT (1 << 29) /**< not quite a bullet. Little, rounder, different. */ #endif #if !defined DMG_CRIT @@ -116,7 +116,7 @@ enum SDKHookType SDKHook_UsePost, SDKHook_Reload, SDKHook_ReloadPost, - SDKHook_GetMaxHealth, // ep2v and later + SDKHook_GetMaxHealth, /**< ep2v and later */ }; /* diff --git a/plugins/include/sdktools_entinput.inc b/plugins/include/sdktools_entinput.inc index 1af2ec70..5f12cf9b 100644 --- a/plugins/include/sdktools_entinput.inc +++ b/plugins/include/sdktools_entinput.inc @@ -109,7 +109,7 @@ native SetVariantColor(const color[4]); /** * Sets an entity in the global variant object. * - * @param Entity index. + * @param entity Entity index. * @noreturn * @error Invalid entity index. */ diff --git a/plugins/include/sdktools_functions.inc b/plugins/include/sdktools_functions.inc index dd0a6ab2..a11cce90 100644 --- a/plugins/include/sdktools_functions.inc +++ b/plugins/include/sdktools_functions.inc @@ -81,13 +81,13 @@ native GetPlayerWeaponSlot(client, slot); native IgniteEntity(entity, Float:time, bool:npc=false, Float:size=0.0, bool:level=false); /** - * Extinguishes a player that is on fire. + * Extinguishes an entity that is on fire. * * @param entity Entity index. * @noreturn * @error Invalid entity or client not in game, or lack of mod support. */ -native ExtinguishEntity(client); +native ExtinguishEntity(entity); /** * Teleports an entity. @@ -194,7 +194,7 @@ native bool:DispatchKeyValueFloat(entity, const String:keyName[], Float:value); * @return True on success, false otherwise. * @error Invalid entity index, or no mod support. */ -native bool:DispatchKeyValueVector(entity, const String:keyName[], const Float:vector[3]); +native bool:DispatchKeyValueVector(entity, const String:keyName[], const Float:vec[3]); /** * Returns the entity a client is aiming at. @@ -293,7 +293,7 @@ native GetServerNetStats(&Float:in, &Float:out); * Equip's a player's weapon. * * @param client Client index. - * @param item CBaseCombatWeapon entity index. + * @param weapon CBaseCombatWeapon entity index. * @noreturn * @error Invalid client or entity, lack of mod support, or client not in * game. diff --git a/plugins/include/sdktools_gamerules.inc b/plugins/include/sdktools_gamerules.inc index 68b42440..ea8db615 100644 --- a/plugins/include/sdktools_gamerules.inc +++ b/plugins/include/sdktools_gamerules.inc @@ -93,6 +93,7 @@ native GameRules_GetProp(const String:prop[], size=4, element=0); * This value is auto-detected, and the size parameter is * only used as a fallback in case detection fails. * @param element Element # (starting from 0) if property is an array. + * @param changeState If true, change will be sent over the network. * @error Not supported. * @noreturn */ @@ -114,6 +115,7 @@ native Float:GameRules_GetPropFloat(const String:prop[], element=0); * @param prop Property name. * @param value Value to set. * @param element Element # (starting from 0) if property is an array. + * @param changeState If true, change will be sent over the network. * @noreturn * @error Not supported. */ @@ -137,6 +139,7 @@ native GameRules_GetPropEnt(const String:prop[], element=0); * @param prop Property name. * @param other Entity index to set, or -1 to unset. * @param element Element # (starting from 0) if property is an array. + * @param changeState If true, change will be sent over the network. * @noreturn * @error Not supported. */ @@ -159,6 +162,7 @@ native GameRules_GetPropVector(const String:prop[], Float:vec[3], element=0); * @param prop Property name. * @param vec Vector to set. * @param element Element # (starting from 0) if property is an array. + * @param changeState If true, change will be sent over the network. * @noreturn * @error Not supported. */ @@ -180,6 +184,7 @@ native GameRules_GetPropString(const String:prop[], String:buffer[], maxlen); * * @param prop Property to use. * @param buffer String to set. + * @param changeState If true, change will be sent over the network. * @return Number of non-null bytes written. * @error Not supported. */ diff --git a/plugins/include/sdktools_sound.inc b/plugins/include/sdktools_sound.inc index 87837408..8189ee55 100644 --- a/plugins/include/sdktools_sound.inc +++ b/plugins/include/sdktools_sound.inc @@ -127,7 +127,7 @@ enum * @param name Sound file name relative to the "sounds" folder. * @noreturn */ -native PrefetchSound(const String:nane[]); +native PrefetchSound(const String:name[]); /** * This function is not known to work, and may crash. You should diff --git a/plugins/include/sdktools_stringtables.inc b/plugins/include/sdktools_stringtables.inc index eb628c72..bd0c12a6 100644 --- a/plugins/include/sdktools_stringtables.inc +++ b/plugins/include/sdktools_stringtables.inc @@ -86,7 +86,7 @@ native GetStringTableName(tableidx, String:name[], maxlength); * Searches for the index of a given string in a string table. * * @param tableidx A string table index. - * @param string String to find. + * @param str String to find. * @return String index if found, INVALID_STRING_INDEX otherwise. * @error Invalid string table index. */ @@ -97,12 +97,12 @@ native FindStringIndex(tableidx, const String:str[]); * * @param tableidx A string table index. * @param stringidx A string index. - * @param name Buffer to store the string value. + * @param str Buffer to store the string value. * @param maxlength Maximum length of string buffer. * @return Number of bytes written to the buffer (UTF-8 safe). * @error Invalid string table index or string index. */ -native ReadStringTable(tableidx, stringIdx, String:str[], maxlength); +native ReadStringTable(tableidx, stringidx, String:str[], maxlength); /** * Returns the length of the user data associated with a given string index. @@ -124,7 +124,7 @@ native GetStringTableDataLength(tableidx, stringidx); * @return Number of bytes written to the buffer (UTF-8 safe). * @error Invalid string table index or string index. */ -native GetStringTableData(tableidx, stringIdx, String:userdata[], maxlength); +native GetStringTableData(tableidx, stringidx, String:userdata[], maxlength); /** * Sets the user data associated with a given string index. @@ -136,13 +136,13 @@ native GetStringTableData(tableidx, stringIdx, String:userdata[], maxlength); * @return Number of bytes written to the buffer (UTF-8 safe). * @error Invalid string table index or string index. */ -native SetStringTableData(tableidx, stringIdx, const String:userdata[], length); +native SetStringTableData(tableidx, stringidx, const String:userdata[], length); /** * Adds a string to a given string table. * * @param tableidx A string table index. - * @param string String to add. + * @param str String to add. * @param userdata An optional user data string. * @param length Length of user data string. This should include the null terminator. * If set to -1, then user data will be not be altered if the specified string diff --git a/plugins/include/sdktools_tempents_stocks.inc b/plugins/include/sdktools_tempents_stocks.inc index 9be534a8..c2a9e37e 100644 --- a/plugins/include/sdktools_tempents_stocks.inc +++ b/plugins/include/sdktools_tempents_stocks.inc @@ -100,7 +100,7 @@ stock TE_SetupSparks(const Float:pos[3], const Float:dir[3], Magnitude, TrailLen * @param pos Position of the smoke. * @param Model Precached model index. * @param Scale Scale of the smoke. - * @param Framerate Frame rate of the smoke. + * @param FrameRate Frame rate of the smoke. * @noreturn */ stock TE_SetupSmoke(const Float:pos[3], Model, Float:Scale, FrameRate) @@ -278,7 +278,7 @@ stock TE_SetupBloodSprite(const Float:pos[3], const Float:dir[3], const color[4] * @param Life Time duration of the ring. * @param Width Beam width. * @param Amplitude Beam amplitude. - * @param color Color array (r, g, b, a). + * @param Color Color array (r, g, b, a). * @param Speed Speed of the beam. * @param Flags Beam flags. * @noreturn @@ -321,7 +321,7 @@ stock TE_SetupBeamRingPoint(const Float:center[3], Float:Start_Radius, Float:End * @param EndWidth Final beam width. * @param FadeLength Beam fade time duration. * @param Amplitude Beam amplitude. - * @param color Color array (r, g, b, a). + * @param Color Color array (r, g, b, a). * @param Speed Speed of the beam. * @noreturn */ @@ -361,7 +361,7 @@ stock TE_SetupBeamPoints(const Float:start[3], const Float:end[3], ModelIndex, H * @param EndWidth Final beam width. * @param FadeLength Beam fade time duration. * @param Amplitude Beam amplitude. - * @param color Color array (r, g, b, a). + * @param Color Color array (r, g, b, a). * @param Speed Speed of the beam. * @noreturn */ @@ -399,7 +399,7 @@ stock TE_SetupBeamLaser(StartEntity, EndEntity, ModelIndex, HaloIndex, StartFram * @param Life Time duration of the ring. * @param Width Beam width. * @param Amplitude Beam amplitude. - * @param color Color array (r, g, b, a). + * @param Color Color array (r, g, b, a). * @param Speed Speed of the beam. * @param Flags Beam flags. * @noreturn @@ -436,7 +436,7 @@ stock TE_SetupBeamRing(StartEntity, EndEntity, ModelIndex, HaloIndex, StartFrame * @param Width Initial beam width. * @param EndWidth Final beam width. * @param FadeLength Beam fade time duration. - * @param color Color array (r, g, b, a). + * @param Color Color array (r, g, b, a). * @noreturn */ stock TE_SetupBeamFollow(EntIndex, ModelIndex, HaloIndex, Float:Life, Float:Width, Float:EndWidth, FadeLength, const Color[4]) diff --git a/plugins/include/sdktools_voice.inc b/plugins/include/sdktools_voice.inc index f38d0b87..fae9b334 100644 --- a/plugins/include/sdktools_voice.inc +++ b/plugins/include/sdktools_voice.inc @@ -78,6 +78,7 @@ native GetClientListeningFlags(client); * * @param iReceiver The listener index. * @param iSender The sender index. + * @param bListen True if the receiver can listen to the sender, false otherwise. * @return True if successful otherwise false. */ #pragma deprecated Use SetListenOverride() instead @@ -98,7 +99,7 @@ native bool:GetClientListening(iReceiver, iSender); * * @param iReceiver The listener index. * @param iSender The sender index. - * @param override + * @param override The override of the receiver's ability to listen to the sender. * @return True if successful otherwise false. */ native bool:SetListenOverride(iReceiver, iSender, ListenOverride:override); diff --git a/plugins/include/sorting.inc b/plugins/include/sorting.inc index 93ea49cc..bea35d14 100644 --- a/plugins/include/sorting.inc +++ b/plugins/include/sorting.inc @@ -84,7 +84,7 @@ native SortFloats(Float:array[], array_size, SortOrder:order = Sort_Ascending); * @param order Sorting order to use. * @noreturn */ -native SortStrings(String:array[][], num_strings, SortOrder:order = Sort_Ascending); +native SortStrings(String:array[][], array_size, SortOrder:order = Sort_Ascending); /** * Sort comparison function for 1D array elements. diff --git a/plugins/include/sourcemod.inc b/plugins/include/sourcemod.inc index 5eeac133..e39e3ea8 100644 --- a/plugins/include/sourcemod.inc +++ b/plugins/include/sourcemod.inc @@ -278,7 +278,7 @@ native GetPluginFilename(Handle:plugin, String:buffer[], maxlength); * @return True if being debugged, false otherwise. * @error Invalid Handle. */ -native bool:IsPluginDebugging(Handle:hndl); +native bool:IsPluginDebugging(Handle:plugin); /** * Retrieves a plugin's public info. @@ -328,7 +328,7 @@ native SetFailState(const String:string[], any:...); * Aborts the current callback and throws an error. This function * does not return in that no code is executed following it. * - * @param format String format. + * @param fmt String format. * @param ... Format arguments. * @noreturn * @error Always! diff --git a/plugins/include/string.inc b/plugins/include/string.inc index 8abc87c9..fed99059 100644 --- a/plugins/include/string.inc +++ b/plugins/include/string.inc @@ -119,7 +119,7 @@ stock bool:StrEqual(const String:str1[], const String:str2[], bool:caseSensitive * destination will be truncated. * * @param dest Destination string buffer to copy to. - * @param destlen Destination buffer length (includes null terminator). + * @param destLen Destination buffer length (includes null terminator). * @param source Source string buffer to copy from. * @return Number of cells written. */ @@ -323,7 +323,7 @@ native GetCharBytes(const String:source[]); * * @note Multi-byte characters will always return false. * - * @param char Character to test. + * @param chr Character to test. * @return True if character is alphabetical, otherwise false. */ native bool:IsCharAlpha(chr); @@ -333,7 +333,7 @@ native bool:IsCharAlpha(chr); * * @note Multi-byte characters will always return false. * - * @param char Character to test. + * @param chr Character to test. * @return True if character is numeric, otherwise false. */ native bool:IsCharNumeric(chr); @@ -343,7 +343,7 @@ native bool:IsCharNumeric(chr); * * @note Multi-byte characters will always return false. * - * @param char Character to test. + * @param chr Character to test. * @return True if character is whitespace, otherwise false. */ native bool:IsCharSpace(chr); @@ -351,7 +351,7 @@ native bool:IsCharSpace(chr); /** * Returns if a character is multi-byte or not. * - * @param char Character to test. + * @param chr Character to test. * @return 0 for a normal 7-bit ASCII character, * otherwise number of bytes in multi-byte character. */ @@ -362,7 +362,7 @@ native IsCharMB(chr); * * @note Multi-byte characters will always return false. * - * @param char Character to test. + * @param chr Character to test. * @return True if character is uppercase, otherwise false. */ native bool:IsCharUpper(chr); @@ -372,7 +372,7 @@ native bool:IsCharUpper(chr); * * @note Multi-byte characters will always return false. * - * @param char Character to test. + * @param chr Character to test. * @return True if character is lowercase, otherwise false. */ native bool:IsCharLower(chr); diff --git a/plugins/include/tf2.inc b/plugins/include/tf2.inc index b984bd8b..2c0c7578 100644 --- a/plugins/include/tf2.inc +++ b/plugins/include/tf2.inc @@ -35,13 +35,13 @@ #endif #define _tf2_included -#define TF_STUNFLAG_SLOWDOWN (1 << 0) // activates slowdown modifier -#define TF_STUNFLAG_BONKSTUCK (1 << 1) // bonk sound, stuck -#define TF_STUNFLAG_LIMITMOVEMENT (1 << 2) // disable forward/backward movement -#define TF_STUNFLAG_CHEERSOUND (1 << 3) // cheering sound -#define TF_STUNFLAG_NOSOUNDOREFFECT (1 << 5) // no sound or particle -#define TF_STUNFLAG_THIRDPERSON (1 << 6) // panic animation -#define TF_STUNFLAG_GHOSTEFFECT (1 << 7) // ghost particles +#define TF_STUNFLAG_SLOWDOWN (1 << 0) /**< activates slowdown modifier */ +#define TF_STUNFLAG_BONKSTUCK (1 << 1) /**< bonk sound, stuck */ +#define TF_STUNFLAG_LIMITMOVEMENT (1 << 2) /**< disable forward/backward movement */ +#define TF_STUNFLAG_CHEERSOUND (1 << 3) /**< cheering sound */ +#define TF_STUNFLAG_NOSOUNDOREFFECT (1 << 5) /**< no sound or particle */ +#define TF_STUNFLAG_THIRDPERSON (1 << 6) /**< panic animation */ +#define TF_STUNFLAG_GHOSTEFFECT (1 << 7) /**< ghost particles */ #define TF_STUNFLAGS_LOSERSTATE TF_STUNFLAG_SLOWDOWN|TF_STUNFLAG_NOSOUNDOREFFECT|TF_STUNFLAG_THIRDPERSON #define TF_STUNFLAGS_GHOSTSCARE TF_STUNFLAG_GHOSTEFFECT|TF_STUNFLAG_THIRDPERSON @@ -173,10 +173,11 @@ enum TFObjectMode * Sets a client on fire for 10 seconds. * * @param client Player's index. + * @param attacker Attacker's index. * @noreturn * @error Invalid client index, client not in game, or no mod support. */ -native TF2_IgnitePlayer(client, target); +native TF2_IgnitePlayer(client, attacker); /** * Respawns a client @@ -255,10 +256,10 @@ native TF2_RemovePlayerDisguise(client); * Stuns a client * * @param client Player's index. - * @param float Duration of stun. - * @param float Slowdown percent (as decimal, 0.00-1.00) - * (ignored if TF_STUNFLAG_SLOWDOWN is not set. - * @param int Stun flags. + * @param duration Duration of stun. + * @param slowdown Slowdown percent (as decimal, 0.00-1.00) + * Ignored if TF_STUNFLAG_SLOWDOWN is not set. + * @param stunflags Stun flags. * @param attacker Attacker's index (0 is allowed for world). * @noreturn */ @@ -269,7 +270,7 @@ native TF2_StunPlayer(client, Float:duration, Float:slowdown=0.0, stunflags, att * * @param client Player's index. * @param attacker Attacker's index. - * @param float Duration of bleeding (in seconds). + * @param duration Duration of bleeding (in seconds). * @noreturn */ native TF2_MakeBleed(client, attacker, Float:duration); diff --git a/plugins/include/tf2_stocks.inc b/plugins/include/tf2_stocks.inc index eef22a73..019bf628 100644 --- a/plugins/include/tf2_stocks.inc +++ b/plugins/include/tf2_stocks.inc @@ -461,6 +461,7 @@ stock TF2_GetPlayerConditionFlags(client) * Check whether or not a condition is set on a player * * @param client Player's index. + * @param cond TFCond constant * @return True if set, false otherwise */ stock bool:TF2_IsPlayerInCondition(client, TFCond:cond) diff --git a/plugins/include/timers.inc b/plugins/include/timers.inc index 29e1517c..d0a9ed09 100644 --- a/plugins/include/timers.inc +++ b/plugins/include/timers.inc @@ -92,6 +92,7 @@ native Handle:CreateTimer(Float:interval, Timer:func, any:data=INVALID_HANDLE, f /** * Kills a timer. Use this instead of CloseHandle() if you need more options. * + * @param timer Timer Handle to kill. * @param autoClose If autoClose is true, the data that was passed to CreateTimer() will * be closed as a handle if TIMER_DATA_HNDL_CLOSE was not specified. * @noreturn diff --git a/plugins/include/topmenus.inc b/plugins/include/topmenus.inc index 7fd4840f..38c46798 100644 --- a/plugins/include/topmenus.inc +++ b/plugins/include/topmenus.inc @@ -201,7 +201,7 @@ native TopMenuObject:AddToTopMenu(Handle:topmenu, * Retrieves the info string of a top menu item. * * @param topmenu TopMenu Handle. - * @param object TopMenuObject ID. + * @param parent TopMenuObject ID. * @param buffer Buffer to store info string. * @param maxlength Maximum size of info string. * @return Number of bytes written, not including the diff --git a/plugins/include/usermessages.inc b/plugins/include/usermessages.inc index 2f2a6c97..373c9818 100644 --- a/plugins/include/usermessages.inc +++ b/plugins/include/usermessages.inc @@ -158,7 +158,7 @@ functag public MsgPostHook(UserMsg:msg_id, bool:sent); * @param intercept If intercept is true, message will be fully intercepted, * allowing the user to block the message. Otherwise, * the hook is normal and ignores the return value. - * @param notify Notification function. + * @param post Notification function. * @noreturn * @error Invalid message index. */