Correcting descriptions in includes

plugins/include/amxmodx.inc

@@ -441,7 +441,7 @@ native client_print(index, type, const message[], any:...);
  *
  * @param index     Client index, use 0 to display to all clients
  * @param sender    Client index used as the message sender
- * @param fmt       Formatting rules
+ * @param message   Formatting rules
  * @param ...       Variable number of formatting parameters
  *
  * @return          Number of printed characters
@@ -475,7 +475,7 @@ native engclient_print(player, type, const message[], any:...);
 /**
  * Sends a message to the console of a client or the server.
  *
- * @param index     Client index, or 0 to print to the server console
+ * @param id        Client index, or 0 to print to the server console
  * @param message   Formatting rules
  * @param ...       Variable number of formatting parameters
  *
@@ -1347,7 +1347,7 @@ native log_amx(const string[], any:...);
  *
  * @note The log will include a timestamp with the message.
  *
- * @param string    Formatting rules
+ * @param message   Formatting rules
  * @param ...       Variable number of formatting parameters
  *
  * @return          Number of printed characters
@@ -1360,7 +1360,7 @@ native log_message(const message[], any:...);
  * @note The log will include a timestamp with the message.
  * @note The message can be hooked using "register_logevent".
  *
- * @param string    Formatting rules
+ * @param message   Formatting rules
  * @param ...       Variable number of formatting parameters
  *
  * @return          Number of printed characters
@@ -1372,6 +1372,7 @@ native elog_message(const message[], any:...);
  *
  * @note The log will include a timestamp with the message.
  *
+ * @param file      Log filename
  * @param string    Formatting rules
  * @param ...       Variable number of formatting parameters
  *
@@ -1917,7 +1918,7 @@ native register_clcmd(const client_cmd[], const function[], flags = -1, const in
  *       has required privileges (flags is not -1) and it is not a command
  *       starting with "say".
  *
- * @param client_cmd    Command to register
+ * @param cmd           Command to register
  * @param function      Callback function
  * @param flags         Admin privilege flags required
  * @param info          Command description
@@ -1938,7 +1939,7 @@ native register_concmd(const cmd[], const function[], flags = -1, const info[] =
  * @note For a list of possible access flags, see the ADMIN_* constants in
  *       amxconst.inc
  *
- * @param client_cmd    Command to register
+ * @param server_cmd    Command to register
  * @param function      Callback function
  * @param flags         Admin privilege flags required
  * @param info          Command description
@@ -1989,17 +1990,17 @@ native get_clcmdsnum(flag);
  * @note For a list of possible access flags, see the ADMIN_* constants in
  *       amxconst.inc
  *
- * @param index     Command index
- * @param command   Buffer to copy command name to
- * @param len1      Maximum name buffer size
- * @param flags     Variable to store privilege flags to
- * @param info      Buffer to copy command description to
- * @param len2      Maximum description buffer size
- * @param flag      Only considers commands that can be accessed with
- *                  the specified privilege flags
- * @param info_ml   Variable to store whether the parameter "info" is a multilingual key
+ * @param index      Command index
+ * @param server_cmd Buffer to copy command name to
+ * @param len1       Maximum name buffer size
+ * @param flags      Variable to store privilege flags to
+ * @param info       Buffer to copy command description to
+ * @param len2       Maximum description buffer size
+ * @param flag       Only considers commands that can be accessed with
+ *                   the specified privilege flags
+ * @param info_ml    Variable to store whether the parameter "info" is a multilingual key
  *
- * @return          1 on success, 0 if command was not found
+ * @return           1 on success, 0 if command was not found
  */
 native get_srvcmd(index, server_cmd[], len1, &flags, info[], len2, flag, &bool:info_ml = false);
 
@@ -2023,7 +2024,7 @@ native get_srvcmdsnum(flag);
  *       amxconst.inc
  *
  * @param index     Command index
- * @param command   Buffer to copy command name to
+ * @param cmd       Buffer to copy command name to
  * @param len1      Maximum name buffer size
  * @param flags     Variable to store privilege flags to
  * @param info      Buffer to copy command description to
@@ -2720,6 +2721,8 @@ native register_native(const name[], const handler[], style = 0);
  *          #pragma loadlib <name>
  *       #endif
  *
+ * @param library     Library name
+ *
  * @noreturn
  */
 native register_library(const library[]);
@@ -2862,7 +2865,7 @@ native set_float_byref(param, Float:value);
  *
  * @param param     Argument to retrieve, starting from 1
  * @param dest      Buffer to copy array to
- * @param maxlen    Size of buffer
+ * @param size      Size of buffer
  *
  * @noreturn
  * @error           If used outside of a native callback, or the native was
@@ -2875,7 +2878,7 @@ native get_array(param, dest[], size);
  *
  * @param param     Argument to retrieve, starting from 1
  * @param dest      Buffer to copy array to
- * @param maxlen    Size of buffer
+ * @param size      Size of buffer
  *
  * @noreturn
  * @error           If used outside of a native callback, or the native was
@@ -2888,7 +2891,7 @@ native get_array_f(param, Float:dest[], size);
  *
  * @param param     Argument to set, starting from 1
  * @param source    Buffer to copy array from
- * @param maxlen    Size of buffer
+ * @param size      Size of buffer
  *
  * @noreturn
  * @error           If used outside of a native callback, or the native was
@@ -2901,7 +2904,7 @@ native set_array(param, const source[], size);
  *
  * @param param     Argument to set, starting from 1
  * @param source    Buffer to copy array from
- * @param maxlen    Size of buffer
+ * @param size      Size of buffer
  *
  * @noreturn
  * @error           If used outside of a native callback, or the native was
@@ -3034,6 +3037,8 @@ native set_native_filter(const handler[]);
  * @note Errors occuring inside the handler will not be filtered and cause the
  *       plugin to fail load as if the handler returned PLUGIN_CONTINUE.
  *
+ * @param handler   Function name to call
+ *
  * @return      0 on success, -1 if filtering is not available, -2 if handler
  *              could not be found.
  */

plugins/include/cellarray.inc

@@ -361,7 +361,8 @@ native ArrayInsertStringBefore(Array:which, item, const input[]);
  * Swaps the position of two items.
  *
  * @param which         Array handle
- * @param item1,item2   Item pair to swap
+ * @param item1         Item pair to swap
+ * @param item2         Item pair to swap
  *
  * @noreturn
  * @error               If an invalid handle or an invalid index is provided an

plugins/include/celltrie.inc

@@ -298,6 +298,8 @@ native TrieSnapshotDestroy(&Snapshot:handle);
  *       reading directly from the map.
  * @note Just like in snapshots the keys are not sorted.
  *
+ * @param handle        Map handle
+ *
  * @return              New iterator handle, which must be freed via TrieIterDestroy().
  * @error               Invalid Handle
  */

plugins/include/core.inc

@@ -55,6 +55,7 @@ native getarg(arg, index = 0);
  *
  * @param arg       Argument index
  * @param index     Index to set in the argument (for arrays and strings)
+ * @param value     Argument value
  */
 native setarg(arg, index = 0, value);
 

plugins/include/csx.inc

@@ -47,7 +47,7 @@ enum MapObjective
  * @param damage    Damage dealt to victim
  * @param wpnindex  Weapon id
  * @param hitplace  Body hitplace
- * @param ta        If nonzero the attack was a team attack
+ * @param TA        If nonzero the attack was a team attack
  *
  * @noreturn
  */
@@ -61,11 +61,11 @@ forward client_damage(attacker, victim, damage, wpnindex, hitplace, TA);
  * @note For a list of possible body hitplaces see the HIT_* constants in
  *       amxconst.inc
  *
- * @param attacker  Attacker client index
+ * @param killer    Killer client index
  * @param victim    Victim client index
  * @param wpnindex  Weapon id
  * @param hitplace  Body hitplace
- * @param tk        If nonzero the death was a teamkill
+ * @param TK        If nonzero the death was a teamkill
  *
  * @noreturn
  */

plugins/include/cvars.inc

@@ -212,7 +212,7 @@ native remove_cvar_flags(const cvar[], flags=-1);
  *       why the otherwise equivalent get_pcvar_string() function should be used
  *       instead.
  *
- * @param cvar      Cvar name to retrieve value from
+ * @param cvarname  Cvar name to retrieve value from
  * @param output    Buffer to copy cvar value to
  * @param iLen      Maximum size of the buffer
  *
@@ -281,7 +281,7 @@ native get_cvar_num(const cvarname[]);
  *       why the otherwise equivalent set_pcvar_num() function should be used
  *       instead.
  *
- * @param cvar      Cvar name to set value of
+ * @param cvarname  Cvar name to set value of
  * @param value     Value to set cvar to
  *
  * @noreturn

plugins/include/fakemeta.inc

@@ -89,14 +89,21 @@ native pev_valid(entindex);
  */
 native pev_serial(entindex);
 
-/* Returns any global variable inside globalvars_t structure. Use the glb_* enum.
- *
- * When returning data from glb_pStringBase (the global string table), you may give a pointer into that table
- * in order to get different strings.
- * Example:
- * new model[128]
- * new ptr = pev(id, pev_viewmodel)
- * global_get(glb_pStringBase, ptr, model, 127)
+/** 
+ * Returns any global variable inside globalvars_t structure. Use the glb_* enum.
+ *
+ * @note	When returning data from glb_pStringBase (the global string table),
+ * @note	you may give a pointer into that table in order to get different strings.
+ * @note	Example:
+ * 			new model[128]
+ * 			new ptr = pev(id, pev_viewmodel)
+ * 			global_get(glb_pStringBase, ptr, model, 127)
+ *
+ * @param	_value	Global string table.
+ * @return          0 if unsuccess.
+ *                  1 if success.
+ *                  Otherwise, an global index is returned.
+ *                  To get the value of int, you need to use the value returned by the function.
  */
 native global_get(_value, any:...);
 

plugins/include/file.inc

@@ -386,7 +386,7 @@ native fputs(file, const text[], bool:null_term = false);
  * Writes a line of formatted text to a text file.
  *
  * @param file          Handle to the file
- * @param format        Formatting rules
+ * @param fmt           Formatting rules
  * @param ...           Variable number of format parameters
  *
  * @return              Total number of characters written on success, 0 otherwise
@@ -475,7 +475,7 @@ native rmdir(const path[]);
 /**
  * Creates a directory.
  *
- * @param path          Path to create
+ * @param dirname       Path to create
  * @param mode          Permissions (default is o=rx,g=rx,u=rwx).  Note that folders must have
  *                      the execute bit set on Linux.  On Windows, the mode is ignored.
  * @param use_valve_fs  If true, the Valve file system will be used instead

plugins/include/float.inc

@@ -162,7 +162,7 @@ native Float:floattan(Float:value, anglemode:mode=radian);
  *
  * @note For available units of measurements(modes) look at the anglemode enum
  *
- * @param value         The angle to calculate the hyperbolic sine from
+ * @param angle         The angle to calculate the hyperbolic sine from
  * @param mode          What unit of measurement is the angle specified in
  *                      Defaults to radians
  *
@@ -175,7 +175,7 @@ native Float:floatsinh(Float:angle, anglemode:mode=radian);
  *
  * @note For available units of measurements(modes) look at the anglemode enum
  *
- * @param value         The angle to calculate the hyperbolic cosine from
+ * @param angle         The angle to calculate the hyperbolic cosine from
  * @param mode          What unit of measurement is the angle specified in
  *                      Defaults to radians
  *
@@ -188,7 +188,7 @@ native Float:floatcosh(Float:angle, anglemode:mode=radian);
  *
  * @note For available units of measurements(modes) look at the anglemode enum
  *
- * @param value         The angle to calculate the hyperbolic tangent from
+ * @param angle         The angle to calculate the hyperbolic tangent from
  * @param mode          What unit of measurement is the angle specified in
  *                      Defaults to radians
  *
@@ -213,8 +213,8 @@ native Float:floatabs(Float:value);
  *
  * @note For available units of measurements(modes) look at the anglemode enum
  *
- * @param value         The tangent to calculate the angle from
- * @param mode          What unit of measurement should the output angle be in
+ * @param angle         The tangent to calculate the angle from
+ * @param radix         What unit of measurement should the output angle be in
  *
  * @return              The angle of a tangent
  */
@@ -225,8 +225,8 @@ native Float:floatatan(Float:angle, {anglemode,_}:radix);
  *
  * @note For available units of measurements(modes) look at the anglemode enum
  *
- * @param value         The cosine to calculate the angle from
- * @param mode          What unit of measurement should the output angle be in
+ * @param angle         The cosine to calculate the angle from
+ * @param radix         What unit of measurement should the output angle be in
  *
  * @return              The angle of a cosine
  */
@@ -237,8 +237,8 @@ native Float:floatacos(Float:angle, {anglemode,_}:radix);
  *
  * @note For available units of measurements(modes) look at the anglemode enum
  *
- * @param value         The sine to calculate the angle from
- * @param mode          What unit of measurement should the output angle be in
+ * @param angle         The sine to calculate the angle from
+ * @param radix         What unit of measurement should the output angle be in
  *
  * @return              The angle of a sine
  */
@@ -252,7 +252,7 @@ native Float:floatasin(Float:angle, {anglemode,_}:radix);
  *
  * @param x             Value representing the proportion of the x-coordinate.
  * @param y             Value representing the proportion of the x-coordinate.
- * @param mode          What unit of measurement should the output angle be in
+ * @param radix         What unit of measurement should the output angle be in
  *
  * @return              Arctangent of y/x
  */

plugins/include/geoip.inc

@@ -55,7 +55,7 @@ native bool:geoip_code3_ex(const ip[], result[4]);
  *              Use geoip_code2_ex instead.
  *
  * @param ip        The IP address to lookup.
- * @param result    The result buffer.
+ * @param ccode     The result buffer.
  *
  * @return          The result length.
  */

plugins/include/hamsandwich.inc

@@ -39,8 +39,8 @@
  *
  * @param function		The function to hook.
  * @param EntityClass	The entity classname to hook.
- * @param callback		The forward to call.
- * @param post			Whether or not to forward this in post.
+ * @param Callback		The forward to call.
+ * @param Post			Whether or not to forward this in post.
  * @param specialbot	Whether or not to enable support for bot without "player" classname.
  * @return 				Returns a handle to the forward.  Use EnableHamForward/DisableHamForward to toggle the forward on or off.
  */
@@ -52,8 +52,8 @@ native HamHook:RegisterHam(Ham:function, const EntityClass[], const Callback[],
  * Look at the Ham enum for parameter lists.
  *
  * @param function		The function to hook.
- * @param callback		The forward to call.
- * @param post			Whether or not to forward this in post.
+ * @param Callback		The forward to call.
+ * @param Post			Whether or not to forward this in post.
  * @return 				Returns a handle to the forward.  Use EnableHamForward/DisableHamForward to toggle the forward on or off.
  */
 stock HamHook:RegisterHamPlayer(Ham:function, const Callback[], Post=0)
@@ -70,8 +70,8 @@ stock HamHook:RegisterHamPlayer(Ham:function, const Callback[], Post=0)
  *
  * @param function		The function to hook.
  * @param EntityId		The entity classname to hook.
- * @param callback		The forward to call.
- * @param post			Whether or not to forward this in post.
+ * @param Callback		The forward to call.
+ * @param Post			Whether or not to forward this in post.
  * @return 				Returns a handle to the forward.  Use EnableHamForward/DisableHamForward to toggle the forward on or off.
  */
 native HamHook:RegisterHamFromEntity(Ham:function, EntityId, const Callback[], Post=0);
@@ -98,7 +98,7 @@ native EnableHamForward(HamHook:fwd);
  * Look at the Ham enum for parameter lists.
  *
  * @param function		The function to call.
- * @param id			The id of the entity to execute it on.
+ * @param this			The id of the entity to execute it on.
  */
 native ExecuteHam(Ham:function, this, any:...);
 
@@ -108,7 +108,7 @@ native ExecuteHam(Ham:function, this, any:...);
  * Look at the Ham enum for parameter lists.
  *
  * @param function		The function to call.
- * @param id			The id of the entity to execute it on.
+ * @param this			The id of the entity to execute it on.
  */
 native ExecuteHamB(Ham:function, this, any:...);