GitHub/amxmodx
2
0
Fork 0
mirror of https://github.com/alliedmodders/amxmodx.git synced 2024-12-25 06:15:37 +03:00
Code Issues Projects Releases Wiki Activity

Correcting descriptions in includes

Browse Source
This commit is contained in:
Albertio 2024-02-14 21:29:24 +05:00
parent 27f451a868
commit 2bbf02f105
18 changed files with 92 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
plugins/include/amxmodx.inc
View File

@ -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
@ -1990,7 +1991,7 @@ native get_clcmdsnum(flag);
* amxconst.inc
*
* @param index Command index
* @param command Buffer to copy command name to
* @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
@ -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.
*/

3
plugins/include/cellarray.inc
View File

@ -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

2
plugins/include/celltrie.inc
View File

@ -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
*/

1
plugins/include/core.inc
View File

@ -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);

6
plugins/include/csx.inc
View File

@ -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
*/

4
plugins/include/cvars.inc
View File

@ -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

15
plugins/include/fakemeta.inc
View File

@ -89,14 +89,21 @@ native pev_valid(entindex);
*/
native pev_serial(entindex);
/* Returns any global variable inside globalvars_t structure. Use the glb_* enum.
/**
* 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:
* @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:...);

4
plugins/include/file.inc
View File

@ -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

20
plugins/include/float.inc
View File

@ -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
*/

2
plugins/include/geoip.inc
View File

@ -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.
*/

16
plugins/include/hamsandwich.inc
View File

@ -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:...);

2
plugins/include/lang.inc
View File

@ -51,6 +51,8 @@ native register_dictionary(const filename[]);
/**
* Checks if the language is loaded.
*
* @param name Language name (ISO 639-1)
*
* @return 1 if it is, 0 otherwise
*/
native lang_exists(const name[]);

4
plugins/include/newmenus.inc
View File

@ -346,7 +346,7 @@ native menu_addtext(menu, const text[], slot=1);
* @error Invalid menu resource.
* Too many items on non-paginated menu (max is 10)
*/
native menu_addblank2( menu );
native menu_addblank2(menu);
/**
* Adds a text line to a menu, always shifting the numbering down.
@ -362,7 +362,7 @@ native menu_addblank2( menu );
* @error Invalid menu resource.
* Too many items on non-paginated menu (max is 10)
*/
native menu_addtext2( menu, const text[] );
native menu_addtext2(menu, const text[]);
/**
* Sets a menu property.

6
plugins/include/ns.inc
View File

@ -351,7 +351,7 @@ native ns_set_points(id, points);
* Adds to the player's points spent count in combat.
*
* @param id The player to add this to.
* @param value The value to add to the points spent.
* @param points The value to add to the points spent.
* @return The new value of the points spent variable.
*/
native ns_add_points(id,points);
@ -672,8 +672,8 @@ native Float:ns_add_obs_energy(idObs,Float:value);
* make it so the player no longer receives the upgrade on spawn.
*
* @note This only works in combat.
* @params idPlayer The player index to change upgrades for.
* @params ugprade The impulse number for the upgrade to strip.
* @param idPlayer The player index to change upgrades for.
* @param ugprade The impulse number for the upgrade to strip.
* @return 2 for upgrade removed from player's bought and active list.
* 1 for upgrade removed from player's bought list only.
* 3 for upgrade removed from player's active list only (shouldn't happen, just incase.)

2
plugins/include/regex.inc
View File

@ -241,8 +241,8 @@ native Regex:regex_compile_ex(const pattern[], flags = 0, error[]= "", maxLen =
* @note Use the regex handle passed to this function to extract
* matches with regex_substr().
*
* @param pattern The regular expression pattern.
* @param string The string to check.
* @param pattern The regular expression pattern.
* @param ret Error code, if applicable, or number of results on success.
* See REGEX_ERROR_* defines.
*

8
plugins/include/textparse_ini.inc
View File

@ -181,9 +181,9 @@ native INI_SetParseEnd(INIParser:handle, const func[]);
*
* public bool:OnKeyValue(INIParser:handle, const key[], const value[], bool:invalid_tokens, bool:equal_token, bool:quotes, curtok, any:data)
* -
* @param handle Handle to an INI Parse structure.
* @param kv A KeyValue callback.
* @param ns An optional NewSection callback.
* @param smc Handle to an INI Parse structure.
* @param kvFunc A KeyValue callback.
* @param nsFunc An optional NewSection callback.
*
* @noreturn
*/
@ -196,7 +196,7 @@ native INI_SetReaders(INIParser:smc, const kvFunc[], const nsFunc[] = "" );
* -
* Called whenever a raw line is read.
*
* @param handle The INI Parse handle.
* @param smc The INI Parse handle.
* @param line Contents of line.
* @param lineno The line number it occurs on.
* @param curtok Pointer to optionally store failed position in string.

8
plugins/include/textparse_smc.inc
View File

@ -214,10 +214,10 @@ native SMC_SetParseEnd(SMCParser:handle, const func[]);
*
* public SMCResult:OnEndSection(SMCParser:handle, any:data)
* -
* @param handle Handle to an SMC Parse structure.
* @param kv A KeyValue callback.
* @param ns An optional NewSection callback.
* @param es An optional EndSection callback.
* @param smc Handle to an SMC Parse structure.
* @param kvFunc A KeyValue callback.
* @param nsFunc An optional NewSection callback.
* @param esFunc An optional EndSection callback.
*
* @noreturn
*/

4
plugins/include/vector.inc
View File

@ -36,8 +36,8 @@ native get_distance(const origin1[3], const origin2[3]);
/**
* Calculates the distance between two input float vectors.
*
* @param origin1 The first vector
* @param origin2 The second vector
* @param Origin1 The first vector
* @param Origin2 The second vector
*
* @return The distance between two input vectors
*/